Provides low-level methods for concrete adapters to communicate with a TeamSpeak 3 Server. More...

Inheritance diagram for TeamSpeak3_Adapter_Abstract:

Public Member Functions
	__construct (array $options)
	The TeamSpeak3_Adapter_Abstract constructor. More...

	__destruct ()
	The TeamSpeak3_Adapter_Abstract destructor. More...

	__sleep ()
	Commit pending data. More...

	__wakeup ()
	Reconnects to the remote server. More...

	getProfiler ()
	Returns the profiler timer used for this connection adapter. More...

	getTransport ()
	Returns the transport object used for this connection adapter. More...

	getTransportHost ()
	Returns the hostname or IPv4 address the underlying TeamSpeak3_Transport_Abstract object is connected to. More...

	getTransportPort ()
	Returns the port number of the server the underlying TeamSpeak3_Transport_Abstract object is connected to. More...

Protected Member Functions
	initTransport ($options, $transport="TeamSpeak3_Transport_TCP")
	Loads the transport object object used for the connection adapter and passes a given set of options. More...

	syn ()
	Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server. More...

Detailed Description

Provides low-level methods for concrete adapters to communicate with a TeamSpeak 3 Server.

Constructor & Destructor Documentation

◆ __construct()

__construct ( array $options )

The TeamSpeak3_Adapter_Abstract constructor.

Parameters

array $options

Returns: TeamSpeak3_Adapter_Abstract

   {
     $this->options = $options;
 
     if($this->transport === null)
     {
       $this->syn();
     }
   }

◆ __destruct()

__destruct ( )

abstract

The TeamSpeak3_Adapter_Abstract destructor.

Returns: void

Member Function Documentation

◆ __sleep()

__sleep ( )

Commit pending data.

Returns: array

   {
     return array("options");
   }

◆ __wakeup()

__wakeup ( )

Reconnects to the remote server.

Returns: void

   {
     $this->syn();
   }

◆ getProfiler()

getProfiler ( )

Returns the profiler timer used for this connection adapter.

Returns: TeamSpeak3_Helper_Profiler_Timer

   {
     return TeamSpeak3_Helper_Profiler::get(spl_object_hash($this));
   }

◆ getTransport()

getTransport ( )

Returns the transport object used for this connection adapter.

Returns: TeamSpeak3_Transport_Abstract

   {
     return $this->transport;
   }

◆ getTransportHost()

getTransportHost ( )

Returns the hostname or IPv4 address the underlying TeamSpeak3_Transport_Abstract object is connected to.

Returns: string

   {
     return $this->getTransport()->getConfig("host", "0.0.0.0");
   }

◆ getTransportPort()

getTransportPort ( )

Returns the port number of the server the underlying TeamSpeak3_Transport_Abstract object is connected to.

Returns: string

   {
     return $this->getTransport()->getConfig("port", "0");
   }

◆ initTransport()

initTransport	(	$options,
		$transport = `"TeamSpeak3_Transport_TCP"`
	)

protected

Loads the transport object object used for the connection adapter and passes a given set of options.

Parameters

array	$options
string	$transport

Exceptions

TeamSpeak3_Adapter_Exception

Returns: void

   {
     if(!is_array($options))
     {
       throw new TeamSpeak3_Adapter_Exception("transport parameters must provided in an array");
     }
 
     $this->transport = new $transport($options);
   }

◆ syn()

syn ( )

abstractprotected

Connects the TeamSpeak3_Transport_Abstract object and performs initial actions on the remote server.