RCON Class Reference

Public Member Functions
	__construct (Server $server, $password, $port=19132, $interface="0.0.0.0", $threads=1, $clientsPerThread=50)
	stop ()
	check ()

Data Fields
const	PROTOCOL_VERSION = 3

Constructor & Destructor Documentation

__construct()

__construct	(	Server	$server,
			$password,
			$port = 19132,
			$interface = "0.0.0.0",
			$threads = 1,
			$clientsPerThread = 50
	)

RCON constructor.

Parameters

Server	$server
	$password
int	$port
string	$interface
int	$threads
int	$clientsPerThread

                                                                                                                                       {
        $this->server = $server;
        $this->workers = [];
        $this->password = (string) $password;
        $this->server->getLogger()->info("Starting remote control listener");
        if($this->password === ""){
            $this->server->getLogger()->critical("RCON can't be started: Empty password");

            return;
        }
        $this->threads = (int) max(1, $threads);
        $this->clientsPerThread = (int) max(1, $clientsPerThread);
        $this->socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
        if($this->socket === false or !socket_bind($this->socket, $interface, (int) $port) or !socket_listen($this->socket)){
            $this->server->getLogger()->critical("RCON can't be started: " . socket_strerror(socket_last_error()));
            $this->threads = 0;
            return;
        }
        socket_set_block($this->socket);

        for($n = 0; $n < $this->threads; ++$n){
            $this->workers[$n] = new RCONInstance($this->server->getLogger(), $this->socket, $this->password, $this->clientsPerThread);
        }
        socket_getsockname($this->socket, $addr, $port);
        $this->server->getLogger()->info("RCON running on $addr:$port");
    }

Member Function Documentation

check()

check

(

)

                           {
        $d = Utils::getRealMemoryUsage();

        $u = Utils::getMemoryUsage(true);
        $usage = round(($u[0] / 1024) / 1024, 2) . "/" . round(($d[0] / 1024) / 1024, 2) . "/" . round(($u[1] / 1024) / 1024, 2) . "/" . round(($u[2] / 1024) / 1024, 2) . " MB @ " . Utils::getThreadCount() . " threads";
        $serverStatus = serialize([
            "online" => count($this->server->getOnlinePlayers()),
            "max" => $this->server->getMaxPlayers(),
            "upload" => round($this->server->getNetwork()->getUpload() / 1024, 2),
            "download" => round($this->server->getNetwork()->getDownload() / 1024, 2),
            "tps" => $this->server->getTicksPerSecondAverage(),
            "load" => $this->server->getTickUsageAverage(),
            "usage" => $usage
        ]);
        for($n = 0; $n < $this->threads; ++$n){
            if(!$this->workers[$n]->isTerminated()){
                $this->workers[$n]->serverStatus = $serverStatus;
            }
            if($this->workers[$n]->isTerminated() === true){
                $this->workers[$n] = new RCONInstance($this->socket, $this->password, $this->clientsPerThread);
            }elseif($this->workers[$n]->isWaiting()){
                if($this->workers[$n]->response !== ""){
                    $this->server->getLogger()->info($this->workers[$n]->response);
                    $this->workers[$n]->synchronized(function(RCONInstance $thread){
                        $thread->notify();
                    }, $this->workers[$n]);
                }else{

                    $response = new RemoteConsoleCommandSender();
                    $command = $this->workers[$n]->cmd;

                    $this->server->getPluginManager()->callEvent($ev = new RemoteServerCommandEvent($response, $command));

                    if(!$ev->isCancelled()){
                        $this->server->dispatchCommand($ev->getSender(), $ev->getCommand());
                    }

                    $this->workers[$n]->response = $response->getMessage();
                    $this->workers[$n]->synchronized(function(RCONInstance $thread){
                        $thread->notify();
                    }, $this->workers[$n]);
                }
            }
        }
    }

stop()

stop

(

)

                          {
        for($n = 0; $n < $this->threads; ++$n){
            $this->workers[$n]->close();
            Server::microSleep(50000);
            $this->workers[$n]->close();
            $this->workers[$n]->quit();
        }
        @socket_close($this->socket);
        $this->threads = 0;
    }

Field Documentation

PROTOCOL_VERSION

const PROTOCOL_VERSION = 3

---

The documentation for this class was generated from the following file:

• src/pocketmine/network/rcon/RCON.php