libPMQuery-interruptible

libPMQuery-interruptible is a fork of libPMQuery that adds a mechanism to interrupt pending queries using IPC sockets. This speeds up server shutdowns in instances where the server would otherwise be waiting for pending queries to time out. See the example plugin for usage.

[$ipc_socket, $ipc_name] = PMQuery::interruptible();
$pool->submitTask(new class($ipc_name) extends AsyncTask{
	public function __construct(private string $ipc_name){}
	public function onRun() : void{
		PMQuery::query("play.cosmicpe.me", 19132, 60, $this->ipc_name);
	}
});
$plugin->getScheduler()->scheduleDelayedTask(new ClosureTask(function() use($ipc_socket) : void{
	// interrupt ongoing query from main thread.
	stream_socket_shutdown($ipc_socket, STREAM_SHUT_RDWR);
	fclose($ipc_socket);
}), 20 * 5);

---

A PocketMine Virion which allows plugins to query other servers for a selection of information

Basic Usage

This virion was made for developers to query Pocketmine-MP servers with ease. Here is some basic functionality:

Required imports

The following imports are necessary to use the virion library:

use jasonw4331\libpmquery\PMQuery;
use jasonw4331\libpmquery\PmQueryException;

API

The querying API is a single function which grabs the data from whatever server you input. Usage is as follows:

$query = PMQuery::query("my.server.net", 19132);

The values returned will follow these values/types:

$query['GameName'];         // Returns the server software being used
$query['HostName'];         // Returns the server host name
$query['Protocol'];         // Returns the protocol version allowed to connect
$query['Version'];          // Returns the client version allowed to connect
$query['Players'];          // Returns the number of players on the server currently
$query['MaxPlayers'];       // Returns the maximum player count of the server
$query['ServerId'];         // Returns the raknet server id
$query['Map'];              // Returns the default world name
$query['GameMode'];         // Returns the default gamemode
$query['NintendoLimited'];  // Returns the status of Nintendo's limitation to join
$query['IPv4Port'];         // Returns the ipv4 port number
$query['IPv6Port'];         // Returns the ipv6 port number
$query['Extra'];            // I still don't know what this info is

Offline Queries

Queries sent to offline servers always throw a PmQueryException. Exceptions can be caught in a try/catch statement to log their offline status.

try{
    $query = PMQuery::query("my.server.net", 19133);
    $players = (int) $query['Players'];
    Server::getInstance()->getLogger()->info("There are ".$players." on the queried server right now!");
}catch(PmQueryException $e){
    //you can choose to log this if you want
    Server::getInstance()->getLogger()->info("The queried server is offline right now!");
}