Public Member Functions | |
| connect () | |
| readLine (string $token="\n") | |
| sendLine (string $data, string $separator="\n") | |
| send (string $data) | |
| Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP | |
| disconnect () | |
| read (int $length=4096) | |
| Public Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport | |
| __construct (array $config) | |
| __sleep () | |
| __wakeup () | |
| __destruct () | |
| getStream () | |
| getConfig (string $key=null, mixed $default=null) | |
| setAdapter (Adapter $adapter) | |
| getAdapter () | |
| getAdapterType () | |
| getMetaData () | |
| isConnected () | |
Public Attributes | |
| const | S_WELCOME_L0 = 'TS3' |
| const | S_WELCOME_L1 = 'Welcome to the TeamSpeak 3 ServerQuery interface, type "help" for a list of commands and "help <command>" for information on a specific command.' |
| const | S_ERROR_OK = 'error id=0 msg=ok' |
| const | CMD |
Protected Member Functions | |
| fget () | |
| fwrite ($data) | |
| Protected Member Functions inherited from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport | |
| waitForReadyRead (int $time=0) | |
Protected Attributes | |
| mixed | $reply = null |
| Protected Attributes inherited from PlanetTeamSpeak\TeamSpeak3Framework\Transport\Transport | |
| array | $config |
| $stream = null | |
| $session = null | |
| Adapter | $adapter = null |
Detailed Description
Definition at line 9 of file MockTCP.php.
Member Function Documentation
◆ connect()
| PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP::connect | ( | ) |
Connects to a remote server.
- Returns
- void
- Exceptions
-
TransportException ServerQueryException
Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP.
Definition at line 22 of file MockTCP.php.
◆ fget()
|
protected |
Definition at line 73 of file MockTCP.php.
◆ fwrite()
|
protected |
Definition at line 81 of file MockTCP.php.
◆ readLine()
| PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP::readLine | ( | string | $token = "\n" | ) |
Reads a single line of data from the stream.
- Parameters
-
string $token
- Returns
- StringHelper
- Exceptions
-
TransportException ServerQueryException
Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP.
Definition at line 32 of file MockTCP.php.
◆ send()
| PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP::send | ( | string | $data | ) |
Writes data to the stream.
- Parameters
-
string $data
- Returns
- void
Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP.
Definition at line 67 of file MockTCP.php.
◆ sendLine()
| PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP::sendLine | ( | string | $data, |
| string | $separator = "\n" ) |
Writes a line of data to the stream.
- Parameters
-
string $data string $separator
- Returns
- void
- Exceptions
-
TransportException ServerQueryException
Reimplemented from PlanetTeamSpeak\TeamSpeak3Framework\Transport\TCP.
Definition at line 56 of file MockTCP.php.
Member Data Documentation
◆ $reply
|
protected |
Definition at line 20 of file MockTCP.php.
◆ CMD
| const PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP::CMD |
Definition at line 15 of file MockTCP.php.
◆ S_ERROR_OK
| const PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP::S_ERROR_OK = 'error id=0 msg=ok' |
Definition at line 13 of file MockTCP.php.
◆ S_WELCOME_L0
| const PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP::S_WELCOME_L0 = 'TS3' |
Definition at line 11 of file MockTCP.php.
◆ S_WELCOME_L1
| const PlanetTeamSpeak\TeamSpeak3Framework\Transport\MockTCP::S_WELCOME_L1 = 'Welcome to the TeamSpeak 3 ServerQuery interface, type "help" for a list of commands and "help <command>" for information on a specific command.' |
Definition at line 12 of file MockTCP.php.
The documentation for this class was generated from the following file:
- src/Transport/MockTCP.php
