Network Class Reference

Public Member Functions
	__construct (Server $server)
	addStatistics ($upload, $download)
	getUpload ()
	getDownload ()
	resetStatistics ()
	getInterfaces ()
	processInterfaces ()
	registerInterface (SourceInterface $interface)
	unregisterInterface (SourceInterface $interface)
	setName ($name)
	getName ()
	updateName ()
	registerPacket ($id, $class)
	getServer ()
	processBatch (BatchPacket $packet, Player $p)
	sendPacket ($address, $port, $payload)
	blockAddress ($address, $timeout=300)
	unblockAddress ($address)

Static Public Attributes
static	$BATCH_THRESHOLD = 512

Constructor & Destructor Documentation

__construct()

__construct

(

Server

$server

)

Network constructor.

Parameters

Server

$server

                                               {

        $this->registerPackets();

        $this->server = $server;
    }

Member Function Documentation

addStatistics()

addStatistics	(		$upload,
			$download
	)

Parameters

$upload
$download

                                                     {
        $this->upload += $upload;
        $this->download += $download;
    }

blockAddress()

blockAddress	(		$address,
			$timeout = 300
	)

Blocks an IP address from the main interface. Setting timeout to -1 will block it forever

Parameters

string	$address
int	$timeout

                                                          {
        foreach($this->advancedInterfaces as $interface){
            $interface->blockAddress($address, $timeout);
        }
    }

getDownload()

getDownload

(

)

Returns

int

                                 {
        return $this->download;
    }

getInterfaces()

getInterfaces

(

)

Returns

SourceInterface[]

                                   {
        return $this->interfaces;
    }

getName()

getName

(

)

                             {
        return $this->name;
    }

getServer()

getServer

(

)

Returns

Server

                               {
        return $this->server;
    }

getUpload()

getUpload

(

)

Returns

int

                               {
        return $this->upload;
    }

processBatch()

processBatch	(	BatchPacket	$packet,
		Player	$p
	)

Parameters

BatchPacket	$packet
Player	$p

                                                                {
        try{
            if(strlen($packet->payload) === 0){
                //prevent zlib_decode errors for incorrectly-decoded packets
                throw new \InvalidArgumentException("BatchPacket payload is empty or packet decode error");
            }

            $str = zlib_decode($packet->payload, 1024 * 1024 * 64); //Max 64MB
            $len = strlen($str);

            if($len === 0){
                throw new \InvalidStateException("Decoded BatchPacket payload is empty");
            }

            $stream = new BinaryStream($str);

            while($stream->offset < $len){
                $buf = $stream->getString();
                if(($pk = $this->getPacket(ord($buf{0}))) !== null){
                    if($pk::NETWORK_ID === 0xfe){
                        throw new \InvalidStateException("Invalid BatchPacket inside BatchPacket");
                    }

                    $pk->setBuffer($buf, 1);

                    $pk->decode();
                    assert($pk->feof(), "Still " . strlen(substr($pk->buffer, $pk->offset)) . " bytes unread in " . get_class($pk));
                    $p->handleDataPacket($pk);
                }
            }
        }catch(\Throwable $e){
            if(\pocketmine\DEBUG > 1){
                $logger = $this->server->getLogger();
                if($logger instanceof MainLogger){
                    $logger->debug("BatchPacket " . " 0x" . bin2hex($packet->payload));
                    $logger->logException($e);
                }
            }
        }
    }

processInterfaces()

processInterfaces

(

)

                                       {
        foreach($this->interfaces as $interface){
            try{
                $interface->process();
            }catch(\Throwable $e){
                $logger = $this->server->getLogger();
                if(\pocketmine\DEBUG > 1){
                    if($logger instanceof MainLogger){
                        $logger->logException($e);
                    }
                }

                $interface->emergencyShutdown();
                $this->unregisterInterface($interface);
                $logger->critical($this->server->getLanguage()->translateString("pocketmine.server.networkError", [get_class($interface), $e->getMessage()]));
            }
        }
    }

registerInterface()

registerInterface

(

SourceInterface

$interface

)

Parameters

SourceInterface

$interface

                                                                 {
        $this->interfaces[$hash = spl_object_hash($interface)] = $interface;
        if($interface instanceof AdvancedSourceInterface){
            $this->advancedInterfaces[$hash] = $interface;
            $interface->setNetwork($this);
        }
        $interface->setName($this->name);
    }

registerPacket()

registerPacket	(		$id,
			$class
	)

Parameters

int	$id	0-255
DataPacket	$class

                                               {
        $this->packetPool[$id] = new $class;
    }

resetStatistics()

resetStatistics

(

)

                                     {
        $this->upload = 0;
        $this->download = 0;
    }

sendPacket()

sendPacket	(		$address,
			$port,
			$payload
	)

Parameters

string	$address
int	$port
string	$payload

                                                         {
        foreach($this->advancedInterfaces as $interface){
            $interface->sendRawPacket($address, $port, $payload);
        }
    }

setName()

setName

(

$name

)

Sets the server name shown on each interface Query

Parameters

string

$name

                                  {
        $this->name = (string) $name;
        foreach($this->interfaces as $interface){
            $interface->setName($this->name);
        }
    }

unblockAddress()

unblockAddress

(

$address

)

Unblocks an IP address from the main interface.

Parameters

string

$address

                                            {
        foreach($this->advancedInterfaces as $interface){
            $interface->unblockAddress($address);
        }
    }

unregisterInterface()

unregisterInterface

(

SourceInterface

$interface

)

Parameters

SourceInterface

$interface

                                                                   {
        unset($this->interfaces[$hash = spl_object_hash($interface)],
            $this->advancedInterfaces[$hash]);
    }

updateName()

updateName

(

)

                                {
        foreach($this->interfaces as $interface){
            $interface->setName($this->name);
        }
    }

Field Documentation

$BATCH_THRESHOLD

$BATCH_THRESHOLD = 512

static

---

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

• src/pocketmine/network/Network.php