Phpcraft
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Phpcraft\Packet\KeepAliveResponsePacket Class Reference
Inheritance diagram for Phpcraft\Packet\KeepAliveResponsePacket:
Inheritance graph
[legend]
Collaboration diagram for Phpcraft\Packet\KeepAliveResponsePacket:
Collaboration graph
[legend]

Public Member Functions

 __construct ($keepAliveId)
 
 send (Connection $con)
 
 __toString ()
 

Static Public Member Functions

static read (Connection $con)
 

Public Attributes

 $keepAliveId
 

Detailed Description

Sent by the client to the server in response to KeepAliveRequestPacket to ensure it is still connected.

Constructor & Destructor Documentation

◆ __construct()

Phpcraft\Packet\KeepAliveResponsePacket::__construct (   $keepAliveId)
Parameters
GMP | string | integer$keepAliveIdThe identifier of the keep alive request packet this response is for.

Member Function Documentation

◆ __toString()

Phpcraft\Packet\KeepAliveResponsePacket::__toString ( )

Reimplemented from Phpcraft\Packet\Packet.

◆ read()

static Phpcraft\Packet\KeepAliveResponsePacket::read ( Connection  $con)
static

Initialises the packet class by reading its payload from the given Connection.

Parameters
Connection$con
Returns
KeepAliveResponsePacket
Exceptions
IOException

Reimplemented from Phpcraft\Packet\Packet.

◆ send()

Phpcraft\Packet\KeepAliveResponsePacket::send ( Connection  $con)

Adds the packet's ID and payload to the Connection's write buffer and sends it over the wire if the connection has a stream. Note that in some cases this will produce multiple Minecraft packets, therefore you should only use this on connections without a stream if you know what you're doing.

Parameters
Connection$con
Returns
void
Exceptions
IOException

Reimplemented from Phpcraft\Packet\Packet.

Member Data Documentation

◆ $keepAliveId

GMP Phpcraft\Packet\KeepAliveResponsePacket::$keepAliveId

The identifier of this keep alive packet.