ts3phpframework
Loading...
Searching...
No Matches
PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface Class Reference

Interface class describing the layout for PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal callbacks. More...

Public Member Functions

 onConnect (Adapter $adapter)
 onDisconnect ()
 onCommandStarted (string $cmd)
 onCommandFinished (string $cmd, Reply $reply)
 onEvent (Event $event, Host $host)
 onError (Reply $reply)
 onServerselected (Host $host)
 onServercreated (Host $host, int $sid)
 onServerdeleted (Host $host, int $sid)
 onServerstarted (Host $host, int $sid)
 onServerstopped (Host $host, int $sid)
 onServershutdown (Host $host)
 onLogin (Host $host)
 onLogout (Host $host)
 onTokencreated (Server $server, string $token)
 onFtHandshake (FileTransfer $adapter)
 onFtUploadStarted (string $ftkey, int $seek, int $size)
 onFtUploadProgress (string $ftkey, int $seek, int $size)
 onFtUploadFinished (string $ftkey, int $seek, int $size)
 onFtDownloadStarted (string $ftkey, int $buff, int $size)
 onFtDownloadProgress (string $ftkey, int $buff, int $size)
 onFtDownloadFinished (string $ftkey, int $buff, int $size)
 onDebugDataRead (string $data)
 onDebugDataSend (string $data)
 onWaitTimeout (int $time, Adapter $adapter)
 onException (SignalException $e)

Detailed Description

Interface class describing the layout for PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal callbacks.

Definition at line 19 of file SignalInterface.php.

Member Function Documentation

◆ onCommandFinished()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onCommandFinished ( string $cmd,
Reply $reply )

Possible callback for 'serverqueryCommandFinished' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("serverqueryCommandFinished", array($object, "onCommandFinished"));
Parameters
string$cmd
Reply$reply
Returns
void

◆ onCommandStarted()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onCommandStarted ( string $cmd)

Possible callback for 'serverqueryCommandStarted' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("serverqueryCommandStarted", array($object, "onCommandStarted"));
Parameters
string$cmd
Returns
void

◆ onConnect()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onConnect ( Adapter $adapter)

Possible callback for '<adapter>Connected' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("serverqueryConnected", array($object, "onConnect"));
  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferConnected", array($object, "onConnect"));
Parameters
Adapter$adapter
Returns
void

◆ onDebugDataRead()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onDebugDataRead ( string $data)

Possible callback for '<adapter>DataRead' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("serverqueryDataRead", array($object, "onDebugDataRead"));
  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferDataRead", array($object, "onDebugDataRead"));
Parameters
string$data
Returns
void

◆ onDebugDataSend()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onDebugDataSend ( string $data)

Possible callback for '<adapter>DataSend' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("serverqueryDataSend", array($object, "onDebugDataSend"));
  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferDataSend", array($object, "onDebugDataSend"));
Parameters
string$data
Returns
void

◆ onDisconnect()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onDisconnect ( )

Possible callback for '<adapter>Disconnected' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("serverqueryDisconnected", array($object, "onDisconnect"));
  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferDisconnected", array($object, "onDisconnect"));
Returns
void

◆ onError()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onError ( Reply $reply)

Possible callback for 'notifyError' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyError", array($object, "onError"));
Parameters
Reply$reply
Returns
void

◆ onEvent()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onEvent ( Event $event,
Host $host )

Possible callback for 'notifyEvent' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyEvent", array($object, "onEvent"));
Parameters
Event$event
Host$host
Returns
void

◆ onException()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onException ( SignalException $e)

Possible callback for 'errorException' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("errorException", array($object, "onException"));
Parameters
SignalException$e
Returns
void

◆ onFtDownloadFinished()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onFtDownloadFinished ( string $ftkey,
int $buff,
int $size )

Possible callback for 'filetransferDownloadFinished' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferDownloadFinished", array($object, "onFtDownloadFinished"));
Parameters
string$ftkey
integer$buff
integer$size
Returns
void

◆ onFtDownloadProgress()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onFtDownloadProgress ( string $ftkey,
int $buff,
int $size )

Possible callback for 'filetransferDownloadProgress' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferDownloadProgress", array($object, "onFtDownloadProgress"));
Parameters
string$ftkey
integer$buff
integer$size
Returns
void

◆ onFtDownloadStarted()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onFtDownloadStarted ( string $ftkey,
int $buff,
int $size )

Possible callback for 'filetransferDownloadStarted' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferDownloadStarted", array($object, "onFtDownloadStarted"));
Parameters
string$ftkey
integer$buff
integer$size
Returns
void

◆ onFtHandshake()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onFtHandshake ( FileTransfer $adapter)

Possible callback for 'filetransferHandshake' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferHandshake", array($object, "onFtHandshake"));
Parameters
FileTransfer$adapter
Returns
void

◆ onFtUploadFinished()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onFtUploadFinished ( string $ftkey,
int $seek,
int $size )

Possible callback for 'filetransferUploadFinished' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferUploadFinished", array($object, "onFtUploadFinished"));
Parameters
string$ftkey
integer$seek
integer$size
Returns
void

◆ onFtUploadProgress()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onFtUploadProgress ( string $ftkey,
int $seek,
int $size )

Possible callback for 'filetransferUploadProgress' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferUploadProgress", array($object, "onFtUploadProgress"));
Parameters
string$ftkey
integer$seek
integer$size
Returns
void

◆ onFtUploadStarted()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onFtUploadStarted ( string $ftkey,
int $seek,
int $size )

Possible callback for 'filetransferUploadStarted' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferUploadStarted", array($object, "onFtUploadStarted"));
Parameters
string$ftkey
integer$seek
integer$size
Returns
void

◆ onLogin()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onLogin ( Host $host)

Possible callback for 'notifyLogin' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyLogin", array($object, "onLogin"));
Parameters
Host$host
Returns
void

◆ onLogout()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onLogout ( Host $host)

Possible callback for 'notifyLogout' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyLogout", array($object, "onLogout"));
Parameters
Host$host
Returns
void

◆ onServercreated()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onServercreated ( Host $host,
int $sid )

Possible callback for 'notifyServercreated' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyServercreated", array($object, "onServercreated"));
Parameters
Host$host
integer$sid
Returns
void

◆ onServerdeleted()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onServerdeleted ( Host $host,
int $sid )

Possible callback for 'notifyServerdeleted' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyServerdeleted", array($object, "onServerdeleted"));
Parameters
Host$host
integer$sid
Returns
void

◆ onServerselected()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onServerselected ( Host $host)

Possible callback for 'notifyServerselected' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyServerselected", array($object, "onServerselected"));
Parameters
Host$host
Returns
void

◆ onServershutdown()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onServershutdown ( Host $host)

Possible callback for 'notifyServershutdown' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyServershutdown", array($object, "onServershutdown"));
Parameters
Host$host
Returns
void

◆ onServerstarted()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onServerstarted ( Host $host,
int $sid )

Possible callback for 'notifyServerstarted' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyServerstarted", array($object, "onServerstarted"));
Parameters
Host$host
integer$sid
Returns
void

◆ onServerstopped()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onServerstopped ( Host $host,
int $sid )

Possible callback for 'notifyServerstopped' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyServerstopped", array($object, "onServerstopped"));
Parameters
Host$host
integer$sid
Returns
void

◆ onTokencreated()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onTokencreated ( Server $server,
string $token )

Possible callback for 'notifyTokencreated' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("notifyTokencreated", array($object, "onTokencreated"));
Parameters
Server$server
string$token
Returns
void

◆ onWaitTimeout()

PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal\SignalInterface::onWaitTimeout ( int $time,
Adapter $adapter )

Possible callback for '<adapter>WaitTimeout' signals.

=== Examples ===

  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("serverqueryWaitTimeout", array($object, "onWaitTimeout"));
  • PlanetTeamSpeak\TeamSpeak3Framework\Helper\Signal::getInstance()->subscribe("filetransferWaitTimeout", array($object, "onWaitTimeout"));
Parameters
integer$time
Adapter$adapter
Returns
void
The documentation for this class was generated from the following file: