PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter Class Reference

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter:

Public Member Functions
	__construct (array $options)
	__destruct ()
	__sleep ()
	__wakeup ()
	getProfiler ()
	getTransport ()
	getTransportHost ()
	getTransportPort ()

Protected Member Functions
	syn ()
	initTransport (array $options, string $transport=TCP::class)

Protected Attributes
array	$options = null
Transport	$transport = null

Detailed Description

Definition at line 15 of file Adapter.php.

Constructor & Destructor Documentation

__construct()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::__construct

(

array

$options

)

The PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter constructor.

Parameters

array

$options

Exceptions

AdapterException

Definition at line 37 of file Adapter.php.

__destruct()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::__destruct ( )

abstract

The PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter destructor.

Returns

void

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer, and PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery.

Member Function Documentation

__sleep()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::__sleep

(

)

Commit pending data.

Returns

array

Definition at line 67 of file Adapter.php.

__wakeup()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::__wakeup

(

)

Reconnects to the remote server.

Returns

void

Exceptions

AdapterException

Definition at line 78 of file Adapter.php.

getProfiler()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::getProfiler

(

)

Returns the profiler timer used for this connection adapter.

Returns

Timer

Definition at line 88 of file Adapter.php.

getTransport()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::getTransport

(

)

Returns the transport object used for this connection adapter.

Returns

Transport|null

Definition at line 98 of file Adapter.php.

getTransportHost()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::getTransportHost

(

)

Returns the hostname or IPv4 address the underlying PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport object is connected to.

Returns

string

Definition at line 122 of file Adapter.php.

getTransportPort()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::getTransportPort

(

)

Returns the port number of the server the underlying PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport object is connected to.

Returns

string

Definition at line 133 of file Adapter.php.

initTransport()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::initTransport ( array $options, string $transport = TCP::class )

protected

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

Parameters

array	$options
string	$transport

Returns

void

Definition at line 111 of file Adapter.php.

syn()

PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::syn ( )

abstractprotected

Connects the PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport object and performs initial actions on the remote server.

Returns

void

Exceptions

AdapterException

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Adapter\FileTransfer, PlanetTeamSpeak\TeamSpeak3Framework\Adapter\MockServerQuery, and PlanetTeamSpeak\TeamSpeak3Framework\Adapter\ServerQuery.

Member Data Documentation

$options

array PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::$options = null

protected

Definition at line 22 of file Adapter.php.

$transport

Transport PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter::$transport = null

protected

Definition at line 29 of file Adapter.php.

---

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

• src/Adapter/Adapter.php