SourceInterface Interface Reference

Public Member Functions
	putPacket (Player $player, DataPacket $packet, $needACK=false, $immediate=true)
	close (Player $player, $reason="unknown reason")
	setName ($name)
	process ()
	shutdown ()
	emergencyShutdown ()

Detailed Description

Classes that implement this interface will be able to be attached to players

Member Function Documentation

close()

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

Terminates the connection

Parameters

Player	$player
string	$reason

Implemented in RakLibInterface.

emergencyShutdown()

emergencyShutdown

(

)

Implemented in RakLibInterface.

process()

process

(

)

Returns

bool

Implemented in RakLibInterface.

putPacket()

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

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

Implemented in RakLibInterface.

setName()

setName

(

$name

)

Parameters

string

$name

Implemented in RakLibInterface.

shutdown()

shutdown

(

)

Implemented in RakLibInterface.

---

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

• src/pocketmine/network/SourceInterface.php