ts3phpframework
Loading...
Searching...
No Matches
PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport Class Reference

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

Inheritance diagram for PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport:
PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP

Public Member Functions

 __construct (array $config)
 __sleep ()
 __wakeup ()
 __destruct ()
 connect ()
 disconnect ()
 read (int $length=4096)
 send (string $data)
 getStream ()
 getConfig (string $key=null, mixed $default=null)
 setAdapter (Adapter $adapter)
 getAdapter ()
 getAdapterType ()
 getMetaData ()
 isConnected ()

Protected Member Functions

 waitForReadyRead (int $time=0)

Protected Attributes

array $config
 $stream = null
 $session = null
Adapter $adapter = null

Detailed Description

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

Definition at line 16 of file Transport.php.

Constructor & Destructor Documentation

◆ __construct()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::__construct ( array $config)

The PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport constructor.

Parameters
array$config
Returns
Transport
Exceptions
TransportException

Definition at line 53 of file Transport.php.

◆ __destruct()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::__destruct ( )

The PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport destructor.

Returns
void

Definition at line 101 of file Transport.php.

Member Function Documentation

◆ __sleep()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::__sleep ( )

Commit pending data.

Returns
array

Definition at line 80 of file Transport.php.

◆ __wakeup()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::__wakeup ( )

Reconnects to the remote server.

Returns
void
Exceptions
TransportException

Definition at line 91 of file Transport.php.

◆ connect()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::connect ( )
abstract

Connects to a remote server.

Returns
void
Exceptions
TransportException

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP, PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP, and PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP.

◆ disconnect()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::disconnect ( )
abstract

Disconnects from a remote server.

Returns
void

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP, and PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP.

◆ getAdapter()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::getAdapter ( )

Returns the PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter object using this transport.

Returns
Adapter|null

Definition at line 184 of file Transport.php.

◆ getAdapterType()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::getAdapterType ( )

Returns the adapter type.

Returns
string

Definition at line 194 of file Transport.php.

◆ getConfig()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::getConfig ( string $key = null,
mixed $default = null )

Returns the configuration variables in this adapter.

Parameters
string | null$key
mixed | null$default
Returns
array|string

Definition at line 159 of file Transport.php.

◆ getMetaData()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::getMetaData ( )

Returns header/meta data from stream pointer.

Returns
array
Exceptions
TransportException

Definition at line 211 of file Transport.php.

◆ getStream()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::getStream ( )

Returns the underlying stream resource.

Returns
resource

Definition at line 147 of file Transport.php.

◆ isConnected()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::isConnected ( )

Returns TRUE if the transport is connected.

Returns
boolean

Definition at line 225 of file Transport.php.

◆ read()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::read ( int $length = 4096)
abstract

Reads data from the stream.

Parameters
integer$length
Returns
StringHelper
Exceptions
TransportException

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP, and PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP.

◆ send()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::send ( string $data)
abstract

Writes data to the stream.

Parameters
string$data
Returns
void

Reimplemented in PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP, PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP, and PlanetTeamSpeak\TeamSpeak3Framework\Transport\UDP.

◆ setAdapter()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::setAdapter ( Adapter $adapter)

Sets the PlanetTeamSpeak\TeamSpeak3Framework\Adapter\Adapter object using this transport.

Parameters
Adapter$adapter
Returns
void

Definition at line 174 of file Transport.php.

◆ waitForReadyRead()

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::waitForReadyRead ( int $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

Definition at line 237 of file Transport.php.

Member Data Documentation

◆ $adapter

Adapter PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::$adapter = null
protected

Definition at line 44 of file Transport.php.

◆ $config

array PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::$config
protected

Definition at line 23 of file Transport.php.

◆ $session

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::$session = null
protected

Definition at line 37 of file Transport.php.

◆ $stream

PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport::$stream = null
protected

Definition at line 30 of file Transport.php.

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