PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP Class Reference

Class for connecting to a remote server through UDP. More...

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP:

Public Member Functions
	connect ()
	disconnect ()
	read (int $length=4096)
	send (string $data)
Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport
	__construct (array $config)
	__sleep ()
	__wakeup ()
	__destruct ()
	getStream ()
	getConfig (string $key=null, mixed $default=null)
	setAdapter (Adapter $adapter)
	getAdapter ()
	getAdapterType ()
	getMetaData ()
	isConnected ()

Additional Inherited Members
Protected Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport
	waitForReadyRead (int $time=0)
Protected Attributes inherited from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport
array	$config
	$stream = null
	$session = null
Adapter	$adapter = null

Detailed Description

Class for connecting to a remote server through UDP.

Definition at line 15 of file UDP.php.

Member Function Documentation

connect()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP::connect

(

)

Connects to a remote server.

Returns

void

Exceptions

TransportException

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport.

Definition at line 23 of file UDP.php.

disconnect()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP::disconnect

(

)

Disconnects from a remote server.

Returns

void

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport.

Definition at line 50 of file UDP.php.

read()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP::read

(

int

$length = 4096

)

Reads data from the stream.

Parameters

integer

$length

Returns

StringHelper

Exceptions

TransportException

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport.

Definition at line 68 of file UDP.php.

send()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP::send

(

string

$data

)

Writes data to the stream.

Parameters

string

$data

Returns

void

Exceptions

TransportException

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport.

Definition at line 91 of file UDP.php.

---

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

• src/Transport/UDP.php