pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket Class Reference

Inheritance diagram for pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket:

Collaboration diagram for pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket:

Public Member Functions
	__get ($name)
	__set ($name, $value)
	canBeSentBeforeLogin ()
	decode (PacketSerializer $in)
	encode (PacketSerializer $out)
	getName ()
	getProtocolVersion ()
	handle (PacketHandlerInterface $handler)
	pid ()

Static Public Member Functions
static	create (int $protocolVersion)

Public Attributes
int	$recipientSubId = 0
int	$senderSubId = 0
const	NETWORK_ID = ProtocolInfo::REQUEST_NETWORK_SETTINGS_PACKET
const	PID_MASK = 0x3ff

Protected Member Functions
	decodeHeader (PacketSerializer $in)
	decodePayload (PacketSerializer $in)
	encodeHeader (PacketSerializer $out)
	encodePayload (PacketSerializer $out)

Detailed Description

This is the first packet sent in a game session. It contains the client's protocol version. The server is expected to respond to this with network settings, which will instruct the client which compression type to use, amongst other things.

Definition at line 24 of file RequestNetworkSettingsPacket.php.

Member Function Documentation

__get()

pocketmine\network\mcpe\protocol\DataPacket::__get ( $name )

inherited

Parameters

string

$name

Returns

mixed

Definition at line 105 of file DataPacket.php.

__set()

pocketmine\network\mcpe\protocol\DataPacket::__set ( $name, $value )

inherited

Parameters

string	$name
mixed	$value

Definition at line 113 of file DataPacket.php.

canBeSentBeforeLogin()

pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket::canBeSentBeforeLogin

(

)

Reimplemented from pocketmine\network\mcpe\protocol\DataPacket.

Definition at line 38 of file RequestNetworkSettingsPacket.php.

create()

static pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket::create ( int $protocolVersion )

static

@generate-create-func

Definition at line 32 of file RequestNetworkSettingsPacket.php.

decode()

pocketmine\network\mcpe\protocol\DataPacket::decode ( PacketSerializer $in )

finalinherited

Exceptions

PacketDecodeException

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 49 of file DataPacket.php.

decodeHeader()

pocketmine\network\mcpe\protocol\DataPacket::decodeHeader ( PacketSerializer $in )

protectedinherited

Exceptions

BinaryDataException
PacketDecodeException

Definition at line 62 of file DataPacket.php.

decodePayload()

pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket::decodePayload ( PacketSerializer $in )

protected

Decodes the packet body, without the packet ID or other generic header fields.

Exceptions

PacketDecodeException
BinaryDataException

Reimplemented from pocketmine\network\mcpe\protocol\DataPacket.

Definition at line 44 of file RequestNetworkSettingsPacket.php.

encode()

pocketmine\network\mcpe\protocol\DataPacket::encode ( PacketSerializer $out )

finalinherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 82 of file DataPacket.php.

encodeHeader()

pocketmine\network\mcpe\protocol\DataPacket::encodeHeader ( PacketSerializer $out )

protectedinherited

Definition at line 87 of file DataPacket.php.

encodePayload()

pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket::encodePayload ( PacketSerializer $out )

protected

Encodes the packet body, without the packet ID or other generic header fields.

Reimplemented from pocketmine\network\mcpe\protocol\DataPacket.

Definition at line 48 of file RequestNetworkSettingsPacket.php.

getName()

pocketmine\network\mcpe\protocol\DataPacket::getName ( )

inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 38 of file DataPacket.php.

getProtocolVersion()

pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket::getProtocolVersion

(

)

Definition at line 42 of file RequestNetworkSettingsPacket.php.

handle()

pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket::handle

(

PacketHandlerInterface

$handler

)

Performs handling for this packet. Usually you'll want an appropriately named method in the session handler for this.

This method returns a bool to indicate whether the packet was handled or not. If the packet was unhandled, a debug message will be logged with a hexdump of the packet.

Typically this method returns the return value of the handler in the supplied PacketHandler. See other packets for examples how to implement this.

Returns

bool true if the packet was handled successfully, false if not.

Exceptions

PacketDecodeException

if broken data was found in the packet

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 52 of file RequestNetworkSettingsPacket.php.

pid()

pocketmine\network\mcpe\protocol\DataPacket::pid ( )

inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 34 of file DataPacket.php.

Member Data Documentation

$recipientSubId

int pocketmine\network\mcpe\protocol\DataPacket::$recipientSubId = 0

inherited

Definition at line 32 of file DataPacket.php.

$senderSubId

int pocketmine\network\mcpe\protocol\DataPacket::$senderSubId = 0

inherited

Definition at line 31 of file DataPacket.php.

NETWORK_ID

const pocketmine\network\mcpe\protocol\RequestNetworkSettingsPacket::NETWORK_ID = ProtocolInfo::REQUEST_NETWORK_SETTINGS_PACKET

Definition at line 25 of file RequestNetworkSettingsPacket.php.

PID_MASK

const pocketmine\network\mcpe\protocol\DataPacket::PID_MASK = 0x3ff

inherited

Definition at line 25 of file DataPacket.php.

---

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

• RequestNetworkSettingsPacket.php