TeamSpeak3_Transport_Abstract Class Reference

Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport. More...

Inheritance diagram for TeamSpeak3_Transport_Abstract:

Public Member Functions
	__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...

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

Detailed Description

Abstract class for connecting to a TeamSpeak 3 Server through different ways of transport.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$config

)

The TeamSpeak3_Transport_Abstract constructor.

Parameters

array

$config

Exceptions

TeamSpeak3_Transport_Exception

Returns

TeamSpeak3_Transport_Abstract

  {
    if(!array_key_exists("host", $config))
    {
      throw new TeamSpeak3_Transport_Exception("config must have a key for 'host' which specifies the server host name");
    }

    if(!array_key_exists("port", $config))
    {
      throw new TeamSpeak3_Transport_Exception("config must have a key for 'port' which specifies the server port number");
    }

    if(!array_key_exists("timeout", $config))
    {
      $config["timeout"] = 10;
    }

    if(!array_key_exists("blocking", $config))
    {
      $config["blocking"] = 1;
    }

    $this->config = $config;
  }

__destruct()

__destruct

(

)

The TeamSpeak3_Transport_Abstract destructor.

Returns

void

  {
    if($this->adapter instanceof TeamSpeak3_Adapter_Abstract)
    {
      $this->adapter->__destruct();
    }

    $this->disconnect();
  }

Member Function Documentation

__sleep()

__sleep

(

)

Commit pending data.

Returns

array

  {
    return array("config");
  }

__wakeup()

__wakeup

(

)

Reconnects to the remote server.

Returns

void

  {
    $this->connect();
  }

connect()

connect ( )

abstract

Connects to a remote server.

Exceptions

TeamSpeak3_Transport_Exception

Returns

void

disconnect()

disconnect ( )

abstract

Disconnects from a remote server.

Returns

void

getAdapter()

getAdapter

(

)

Returns the TeamSpeak3_Adapter_Abstract object using this transport.

Returns

TeamSpeak3_Adapter_Abstract

  {
    return $this->adapter;
  }

getAdapterType()

getAdapterType

(

)

Returns the adapter type.

Returns

string

  {
    if($this->adapter instanceof TeamSpeak3_Adapter_Abstract)
    {
      $string = TeamSpeak3_Helper_String::factory(get_class($this->adapter));

      return $string->substr($string->findLast("_"))->replace(array("_", " "), "")->toString();
    }

    return "Unknown";
  }

getConfig()

getConfig	(		$key = null,
			$default = null
	)

Returns the configuration variables in this adapter.

Parameters

string	$key
mixed	$default

Returns

array

  {
    if($key !== null)
    {
      return array_key_exists($key, $this->config) ? $this->config[$key] : $default;
    }

    return $this->config;
  }

getMetaData()

getMetaData

(

)

Returns header/meta data from stream pointer.

Exceptions

TeamSpeak3_Transport_Exception

Returns

array

  {
    if($this->stream === null)
    {
      throw new TeamSpeak3_Transport_Exception("unable to retrieve header/meta data from stream pointer");
    }

    return stream_get_meta_data($this->stream);
  }

getStream()

getStream

(

)

Returns the underlying stream resource.

Returns

resource

  {
    return $this->stream;
  }

isConnected()

isConnected

(

)

Returns TRUE if the transport is connected.

Returns

boolean

  {
    return (is_resource($this->stream)) ? TRUE : FALSE;
  }

read()

read (   $length = 4096 )

abstract

Reads data from the stream.

Parameters

integer

$length

Exceptions

TeamSpeak3_Transport_Exception

Returns

TeamSpeak3_Helper_String

send()

send (   $data )

abstract

Writes data to the stream.

Parameters

string

$data

Returns

void

setAdapter()

setAdapter

(

TeamSpeak3_Adapter_Abstract

$adapter

)

Sets the TeamSpeak3_Adapter_Abstract object using this transport.

Parameters

TeamSpeak3_Adapter_Abstract

$adapter

Returns

void

  {
    $this->adapter = $adapter;
  }

waitForReadyRead()

waitForReadyRead (   $time = 0 )

protected

Blocks a stream until data is available for reading if the stream is connected in non-blocking mode.

Parameters

integer

$time

Returns

void

  {
    if(!$this->isConnected() || $this->config["blocking"]) return;

    do
    {
      $read = array($this->stream);
      $null = null;

      if($time)
      {
        TeamSpeak3_Helper_Signal::getInstance()->emit(strtolower($this->getAdapterType()) . "WaitTimeout", $time, $this->getAdapter());
      }

      $time = $time+$this->config["timeout"];
    }
    while(@stream_select($read, $null, $null, $this->config["timeout"]) == 0);
  }

---

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

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