TeamSpeak3_Transport_TCP Class Reference

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

Inheritance diagram for TeamSpeak3_Transport_TCP:

Public Member Functions
	connect ()
	Connects to a remote server. More...
	disconnect ()
	Disconnects from a remote server. More...
	read ($length=4096)
	Reads data from the stream. More...
	readLine ($token="\)
	Reads a single line of data from the stream. More...
	send ($data)
	Writes data to the stream. More...
	sendLine ($data, $separator="\)
	Writes a line of data to the stream. More...
Public Member Functions inherited from TeamSpeak3_Transport_Abstract
	__construct (array $config)
	The TeamSpeak3_Transport_Abstract constructor. More...
	__destruct ()
	The TeamSpeak3_Transport_Abstract destructor. More...
	__sleep ()
	Commit pending data. More...
	__wakeup ()
	Reconnects to the remote server. More...
	connect ()
	Connects to a remote server. More...
	disconnect ()
	Disconnects from a remote server. More...
	getAdapter ()
	Returns the TeamSpeak3_Adapter_Abstract object using this transport. More...
	getAdapterType ()
	Returns the adapter type. More...
	getConfig ($key=null, $default=null)
	Returns the configuration variables in this adapter. More...
	getMetaData ()
	Returns header/meta data from stream pointer. More...
	getStream ()
	Returns the underlying stream resource. More...
	isConnected ()
	Returns TRUE if the transport is connected. More...
	read ($length=4096)
	Reads data from the stream. More...
	send ($data)
	Writes data to the stream. More...
	setAdapter (TeamSpeak3_Adapter_Abstract $adapter)
	Sets the TeamSpeak3_Adapter_Abstract object using this transport. More...

Additional Inherited Members
Protected Member Functions inherited from TeamSpeak3_Transport_Abstract
	waitForReadyRead ($time=0)
	Blocks a stream until data is available for reading if the stream is connected in non-blocking mode. More...

Detailed Description

Class for connecting to a remote server through TCP.

Member Function Documentation

connect()

connect

(

)

Connects to a remote server.

Exceptions

TeamSpeak3_Transport_Exception

Returns

void

 {
 if($this->stream !== null) return;

 $host = strval($this->config["host"]);
 $port = strval($this->config["port"]);

 $address = "tcp://" . (strstr($host, ":") !== FALSE ? "[" . $host . "]" : $host) . ":" . $port;
 $timeout = (int) $this->config["timeout"];

 $this->stream = @stream_socket_client($address, $errno, $errstr, $timeout);

 if($this->stream === FALSE)
 {
 throw new TeamSpeak3_Transport_Exception(TeamSpeak3_Helper_String::factory($errstr)->toUtf8()->toString(), $errno);
 }

 @stream_set_timeout($this->stream, $timeout);
 @stream_set_blocking($this->stream, $this->config["blocking"] ? 1 : 0);
 }

disconnect()

disconnect

(

)

Disconnects from a remote server.

Returns

void

 {
 if($this->stream === null) return;

 $this->stream = null;

 TeamSpeak3_Helper_Signal::getInstance()->emit(strtolower($this->getAdapterType()) . "Disconnected");
 }

read()

read

(

$length = 4096

)

Reads data from the stream.

Parameters

integer

$length

Exceptions

TeamSpeak3_Transport_Exception

Returns

TeamSpeak3_Helper_String

 {
 $this->connect();
 $this->waitForReadyRead();

 $data = @stream_get_contents($this->stream, $length);

 TeamSpeak3_Helper_Signal::getInstance()->emit(strtolower($this->getAdapterType()) . "DataRead", $data);

 if($data === FALSE)
 {
 throw new TeamSpeak3_Transport_Exception("connection to server '" . $this->config["host"] . ":" . $this->config["port"] . "' lost");
 }

 return new TeamSpeak3_Helper_String($data);
 }

readLine()

readLine

(

$token = "\n"

)

Reads a single line of data from the stream.

Parameters

string

$token

Exceptions

TeamSpeak3_Transport_Exception

Returns

TeamSpeak3_Helper_String

 {
 $this->connect();

 $line = TeamSpeak3_Helper_String::factory("");

 while(!$line->endsWith($token))
 {
 $this->waitForReadyRead();

 $data = @fgets($this->stream, 4096);

 TeamSpeak3_Helper_Signal::getInstance()->emit(strtolower($this->getAdapterType()) . "DataRead", $data);

 if($data === FALSE)
 {
 if($line->count())
 {
 $line->append($token);
 }
 else
 {
 throw new TeamSpeak3_Transport_Exception("connection to server '" . $this->config["host"] . ":" . $this->config["port"] . "' lost");
 }
 }
 else
 {
 $line->append($data);
 }
 }

 return $line->trim();
 }

send()

send

(

$data

)

Writes data to the stream.

Parameters

string

$data

Returns

void

 {
 $this->connect();

 @stream_socket_sendto($this->stream, $data);

 TeamSpeak3_Helper_Signal::getInstance()->emit(strtolower($this->getAdapterType()) . "DataSend", $data);
 }

sendLine()

sendLine	(		$data,
			$separator = "\n"
	)

Writes a line of data to the stream.

Parameters

string	$data
string	$separator

Returns

void

 {
 $size = strlen($data);
 $pack = 4096;

 for($seek = 0 ;$seek < $size;)
 {
 $rest = $size-$seek;
 $pack = $rest < $pack ? $rest : $pack;
 $buff = substr($data, $seek, $pack);
 $seek = $seek+$pack;

 if($seek >= $size) $buff .= $separator;

 $this->send($buff);
 }
 }

---

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

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Transport/TCP.php