RakLibInterface Class Reference

Inheritance diagram for RakLibInterface:

Collaboration diagram for RakLibInterface:

Public Member Functions
	__construct (Server $server)
	setNetwork (Network $network)
	process ()
	closeSession ($identifier, $reason)
	close (Player $player, $reason="unknown reason")
	shutdown ()
	emergencyShutdown ()
	openSession ($identifier, $address, $port, $clientID)
	handleEncapsulated ($identifier, EncapsulatedPacket $packet, $flags)
	blockAddress ($address, $timeout=300)
	unblockAddress ($address)
	handleRaw ($address, $port, $payload)
	sendRawPacket ($address, $port, $payload)
	notifyACK ($identifier, $identifierACK)
	setName ($name)
	setPortCheck ($name)
	handleOption ($name, $value)
	putPacket (Player $player, DataPacket $packet, $needACK=false, $immediate=false)

Member Function Documentation

blockAddress	(		$address,
			$timeout = 300
	)

Parameters

string	$address
int	$timeout	Seconds

Implements AdvancedSourceInterface.

close	(	Player	$player,
			$reason = "unknown reason"
	)

Terminates the connection

Parameters

Player	$player
string	$reason

Implements SourceInterface.

closeSession	(		$identifier,
			$reason
	)

Parameters

string	$identifier
string	$reason

Implements ServerInstance.

handleEncapsulated	(		$identifier,
		EncapsulatedPacket	$packet,
			$flags
	)

Parameters

string	$identifier
EncapsulatedPacket	$packet
int	$flags

Implements ServerInstance.

handleOption	(		$option,
			$value
	)

Parameters

string	$option
string	$value

Implements ServerInstance.

handleRaw	(		$address,
			$port,
			$payload
	)

Parameters

string	$address
int	$port
string	$payload

Implements ServerInstance.

notifyACK	(		$identifier,
			$identifierACK
	)

Parameters

string	$identifier
int	$identifierACK

Implements ServerInstance.

openSession	(		$identifier,
			$address,
			$port,
			$clientID
	)

Parameters

string	$identifier
string	$address
int	$port
string | int	$clientID

Implements ServerInstance.

process

(

)

Returns

bool

Implements SourceInterface.

putPacket	(	Player	$player,
		DataPacket	$packet,
			$needACK = false,
			$immediate = false
	)

Sends a DataPacket to the interface, returns an unique identifier for the packet if $needACK is true

Parameters

Player	$player
DataPacket	$packet
bool	$needACK
bool	$immediate

Returns

int

Implements SourceInterface.

sendRawPacket	(		$address,
			$port,
			$payload
	)

Parameters

string	$address
int	$port
string	$payload

Implements AdvancedSourceInterface.

setName

(

$name

)

Parameters

string

$name

Implements SourceInterface.

setNetwork

(

Network

$network

)

Parameters

Network

$network

Implements AdvancedSourceInterface.

---

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

• src/pocketmine/network/RakLibInterface.php