pocketmine\event\server\DataPacketDecodeEvent Class Reference

Inheritance diagram for pocketmine\event\server\DataPacketDecodeEvent:

Collaboration diagram for pocketmine\event\server\DataPacketDecodeEvent:

Public Member Functions
	__construct (private NetworkSession $origin, private int $packetId, private string $packetBuffer)
	call ()
	getEventName ()
	getOrigin ()
	getPacketBuffer ()
	getPacketId ()
	isCancelled ()

Static Public Member Functions
static	hasHandlers ()

Protected Attributes
string	$eventName = null

Detailed Description

Called before a packet is decoded and handled by the network session. Cancelling this event will drop the packet without decoding it, minimizing wasted CPU time.

Definition at line 34 of file DataPacketDecodeEvent.php.

Constructor & Destructor Documentation

__construct()

pocketmine\event\server\DataPacketDecodeEvent::__construct	(	private NetworkSession	$origin,
		private int	$packetId,
		private string	$packetBuffer
	)

Definition at line 37 of file DataPacketDecodeEvent.php.

Member Function Documentation

call()

pocketmine\event\Event::call ( )

inherited

Calls event handlers registered for this event.

Exceptions

RuntimeException if event call recursion reaches the max depth limit

Definition at line 49 of file Event.php.

getEventName()

pocketmine\event\Event::getEventName ( )

finalinherited

Definition at line 40 of file Event.php.

getOrigin()

pocketmine\event\server\DataPacketDecodeEvent::getOrigin

(

)

Definition at line 43 of file DataPacketDecodeEvent.php.

getPacketBuffer()

pocketmine\event\server\DataPacketDecodeEvent::getPacketBuffer

(

)

Definition at line 51 of file DataPacketDecodeEvent.php.

getPacketId()

pocketmine\event\server\DataPacketDecodeEvent::getPacketId

(

)

Definition at line 47 of file DataPacketDecodeEvent.php.

hasHandlers()

static pocketmine\event\Event::hasHandlers ( )

staticinherited

Returns whether the current class context has any registered global handlers. This can be used in hot code paths to avoid unnecessary event object creation.

Usage: SomeEventClass::hasHandlers()

Definition at line 77 of file Event.php.

isCancelled()

pocketmine\event\Cancellable::isCancelled ( )

inherited

Returns whether this instance of the event is currently cancelled.

If it is cancelled, only downstream handlers that declare @handleCancelled will be called with this event.

Member Data Documentation

$eventName

string pocketmine\event\Event::$eventName = null

protectedinherited

Definition at line 38 of file Event.php.

---

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

• DataPacketDecodeEvent.php