PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP Class Reference

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

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP:

Public Member Functions
	connect ()
	disconnect ()
	read (int $length=4096)
	readLine (string $token="\n")
	send (string $data)
	sendLine (string $data, string $separator="\n")
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 TCP.

Definition at line 16 of file TCP.php.

Member Function Documentation

connect()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP::connect

(

)

Connects to a remote server.

Returns

void

Exceptions

TransportException
ServerQueryException

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport.

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP.

Definition at line 25 of file TCP.php.

disconnect()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP::disconnect

(

)

Disconnects from a remote server.

Returns

void

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport.

Definition at line 76 of file TCP.php.

read()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP::read

(

int

$length = 4096

)

Reads data from the stream.

Parameters

integer

$length

Returns

StringHelper

Exceptions

TransportException
ServerQueryException

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport.

Definition at line 99 of file TCP.php.

readLine()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP::readLine

(

string

$token = "\n"

)

Reads a single line of data from the stream.

Parameters

string

$token

Returns

StringHelper

Exceptions

TransportException
ServerQueryException

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP.

Definition at line 123 of file TCP.php.

send()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP::send

(

string

$data

)

Writes data to the stream.

Parameters

string

$data

Returns

void

Exceptions

TransportException
ServerQueryException

Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport.

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP.

Definition at line 156 of file TCP.php.

sendLine()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP::sendLine	(	string	$data,
		string	$separator = "\n" )

Writes a line of data to the stream.

Parameters

string	$data
string	$separator

Returns

void

Exceptions

TransportException
ServerQueryException

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP.

Definition at line 174 of file TCP.php.

---

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

• src/Transport/TCP.php