Interface class describing the layout for TeamSpeak3_Helper_Signal callbacks. More...

Public Member Functions
	onConnect (TeamSpeak3_Adapter_Abstract $adapter)
	Possible callback for '<adapter>Connected' signals.
	onDisconnect ()
	Possible callback for '<adapter>Disconnected' signals.
	onCommandStarted ($cmd)
	Possible callback for 'serverqueryCommandStarted' signals.
	onCommandFinished ($cmd, TeamSpeak3_Adapter_ServerQuery_Reply $reply)
	Possible callback for 'serverqueryCommandFinished' signals.
	onEvent (TeamSpeak3_Adapter_ServerQuery_Event $event, TeamSpeak3_Node_Host $host)
	Possible callback for 'notifyEvent' signals.
	onError (TeamSpeak3_Adapter_ServerQuery_Reply $reply)
	Possible callback for 'notifyError' signals.
	onServerselected (TeamSpeak3_Node_Host $host)
	Possible callback for 'notifyServerselected' signals.
	onServercreated (TeamSpeak3_Node_Host $host, $sid)
	Possible callback for 'notifyServercreated' signals.
	onServerdeleted (TeamSpeak3_Node_Host $host, $sid)
	Possible callback for 'notifyServerdeleted' signals.
	onServerstarted (TeamSpeak3_Node_Host $host, $sid)
	Possible callback for 'notifyServerstarted' signals.
	onServerstopped (TeamSpeak3_Node_Host $host, $sid)
	Possible callback for 'notifyServerstopped' signals.
	onServershutdown (TeamSpeak3_Node_Host $host)
	Possible callback for 'notifyServershutdown' signals.
	onLogin (TeamSpeak3_Node_Host $host)
	Possible callback for 'notifyLogin' signals.
	onLogout (TeamSpeak3_Node_Host $host)
	Possible callback for 'notifyLogout' signals.
	onTokencreated (TeamSpeak3_Node_Server $server, $token)
	Possible callback for 'notifyTokencreated' signals.
	onFtHandshake (TeamSpeak3_Adapter_FileTransfer $adapter)
	Possible callback for 'filetransferHandshake' signals.
	onFtUploadStarted ($ftkey, $seek, $size)
	Possible callback for 'filetransferUploadStarted' signals.
	onFtUploadProgress ($ftkey, $seek, $size)
	Possible callback for 'filetransferUploadProgress' signals.
	onFtUploadFinished ($ftkey, $seek, $size)
	Possible callback for 'filetransferUploadFinished' signals.
	onFtDownloadStarted ($ftkey, $buff, $size)
	Possible callback for 'filetransferDownloadStarted' signals.
	onFtDownloadProgress ($ftkey, $buff, $size)
	Possible callback for 'filetransferDownloadProgress' signals.
	onFtDownloadFinished ($ftkey, $buff, $size)
	Possible callback for 'filetransferDownloadFinished' signals.
	onDebugDataRead ($data)
	Possible callback for '<adapter>DataRead' signals.
	onDebugDataSend ($data)
	Possible callback for '<adapter>DataSend' signals.
	onWaitTimeout ($time, TeamSpeak3_Adapter_Abstract $adapter)
	Possible callback for '<adapter>WaitTimeout' signals.
	onException (TeamSpeak3_Exception $e)
	Possible callback for 'errorException' signals.

Detailed Description

Interface class describing the layout for TeamSpeak3_Helper_Signal callbacks.

Definition at line 32 of file Interface.php.

Member Function Documentation

TeamSpeak3_Helper_Signal_Interface::onConnect ( TeamSpeak3_Adapter_Abstract $ adapter )

Possible callback for '<adapter>Connected' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryConnected", array($object, "onConnect"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferConnected", array($object, "onConnect"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("blacklistConnected", array($object, "onConnect"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("updateConnected", array($object, "onConnect"));

Parameters:

TeamSpeak3_Adapter_Abstract $adapter

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onDisconnect ( )

Possible callback for '<adapter>Disconnected' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryDisconnected", array($object, "onDisconnect"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferDisconnected", array($object, "onDisconnect"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("blacklistDisconnected", array($object, "onDisconnect"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("updateDisconnected", array($object, "onDisconnect"));

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onCommandStarted ( $ cmd )

Possible callback for 'serverqueryCommandStarted' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryCommandStarted", array($object, "onCommandStarted"));

Parameters:

string $cmd

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onCommandFinished	(	$	cmd,
		TeamSpeak3_Adapter_ServerQuery_Reply $	reply
	)

Possible callback for 'serverqueryCommandFinished' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryCommandFinished", array($object, "onCommandFinished"));

Parameters:

string	$cmd
TeamSpeak3_Adapter_ServerQuery_Reply	$reply

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onEvent	(	TeamSpeak3_Adapter_ServerQuery_Event $	event,
		TeamSpeak3_Node_Host $	host
	)

Possible callback for 'notifyEvent' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyEvent", array($object, "onEvent"));

Parameters:

TeamSpeak3_Adapter_ServerQuery_Event	$event
TeamSpeak3_Node_Host	$host

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onError ( TeamSpeak3_Adapter_ServerQuery_Reply $ reply )

Possible callback for 'notifyError' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyError", array($object, "onError"));

Parameters:

TeamSpeak3_Adapter_ServerQuery_Reply $reply

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onServerselected ( TeamSpeak3_Node_Host $ host )

Possible callback for 'notifyServerselected' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyServerselected", array($object, "onServerselected"));

Parameters:

TeamSpeak3_Node_Host $host

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onServercreated	(	TeamSpeak3_Node_Host $	host,
		$	sid
	)

Possible callback for 'notifyServercreated' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyServercreated", array($object, "onServercreated"));

Parameters:

TeamSpeak3_Node_Host	$host
integer	$sid

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onServerdeleted	(	TeamSpeak3_Node_Host $	host,
		$	sid
	)

Possible callback for 'notifyServerdeleted' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyServerdeleted", array($object, "onServerdeleted"));

Parameters:

TeamSpeak3_Node_Host	$host
integer	$sid

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onServerstarted	(	TeamSpeak3_Node_Host $	host,
		$	sid
	)

Possible callback for 'notifyServerstarted' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyServerstarted", array($object, "onServerstarted"));

Parameters:

TeamSpeak3_Node_Host	$host
integer	$sid

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onServerstopped	(	TeamSpeak3_Node_Host $	host,
		$	sid
	)

Possible callback for 'notifyServerstopped' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyServerstopped", array($object, "onServerstopped"));

Parameters:

TeamSpeak3_Node_Host	$host
integer	$sid

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onServershutdown ( TeamSpeak3_Node_Host $ host )

Possible callback for 'notifyServershutdown' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyServershutdown", array($object, "onServershutdown"));

Parameters:

TeamSpeak3_Node_Host $host

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onLogin ( TeamSpeak3_Node_Host $ host )

Possible callback for 'notifyLogin' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyLogin", array($object, "onLogin"));

Parameters:

TeamSpeak3_Node_Host $host

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onLogout ( TeamSpeak3_Node_Host $ host )

Possible callback for 'notifyLogout' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyLogout", array($object, "onLogout"));

Parameters:

TeamSpeak3_Node_Host $host

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onTokencreated	(	TeamSpeak3_Node_Server $	server,
		$	token
	)

Possible callback for 'notifyTokencreated' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("notifyTokencreated", array($object, "onTokencreated"));

Parameters:

TeamSpeak3_Node_Server	$server
string	$token

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onFtHandshake ( TeamSpeak3_Adapter_FileTransfer $ adapter )

Possible callback for 'filetransferHandshake' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferHandshake", array($object, "onFtHandshake"));

Parameters:

TeamSpeak3_Adapter_FileTransfer $adapter

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onFtUploadStarted	(	$	ftkey,
		$	seek,
		$	size
	)

Possible callback for 'filetransferUploadStarted' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferUploadStarted", array($object, "onFtUploadStarted"));

Parameters:

string	$ftkey
integer	$seek
integer	$size

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onFtUploadProgress	(	$	ftkey,
		$	seek,
		$	size
	)

Possible callback for 'filetransferUploadProgress' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferUploadProgress", array($object, "onFtUploadProgress"));

Parameters:

string	$ftkey
integer	$seek
integer	$size

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onFtUploadFinished	(	$	ftkey,
		$	seek,
		$	size
	)

Possible callback for 'filetransferUploadFinished' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferUploadFinished", array($object, "onFtUploadFinished"));

Parameters:

string	$ftkey
integer	$seek
integer	$size

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onFtDownloadStarted	(	$	ftkey,
		$	buff,
		$	size
	)

Possible callback for 'filetransferDownloadStarted' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferDownloadStarted", array($object, "onFtDownloadStarted"));

Parameters:

string	$ftkey
integer	$buff
integer	$size

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onFtDownloadProgress	(	$	ftkey,
		$	buff,
		$	size
	)

Possible callback for 'filetransferDownloadProgress' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferDownloadProgress", array($object, "onFtDownloadProgress"));

Parameters:

string	$ftkey
integer	$buff
integer	$size

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onFtDownloadFinished	(	$	ftkey,
		$	buff,
		$	size
	)

Possible callback for 'filetransferDownloadFinished' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferDownloadFinished", array($object, "onFtDownloadFinished"));

Parameters:

string	$ftkey
integer	$buff
integer	$size

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onDebugDataRead ( $ data )

Possible callback for '<adapter>DataRead' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryDataRead", array($object, "onDebugDataRead"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferDataRead", array($object, "onDebugDataRead"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("blacklistDataRead", array($object, "onDebugDataRead"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("updateDataRead", array($object, "onDebugDataRead"));

Parameters:

string $data

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onDebugDataSend ( $ data )

Possible callback for '<adapter>DataSend' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryDataSend", array($object, "onDebugDataSend"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferDataSend", array($object, "onDebugDataSend"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("blacklistDataSend", array($object, "onDebugDataSend"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("updateDataSend", array($object, "onDebugDataSend"));

Parameters:

string $data

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onWaitTimeout	(	$	time,
		TeamSpeak3_Adapter_Abstract $	adapter
	)

Possible callback for '<adapter>WaitTimeout' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("serverqueryWaitTimeout", array($object, "onWaitTimeout"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("filetransferWaitTimeout", array($object, "onWaitTimeout"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("blacklistWaitTimeout", array($object, "onWaitTimeout"));
TeamSpeak3_Helper_Signal::getInstance()->subscribe("updateWaitTimeout", array($object, "onWaitTimeout"));

Parameters:

integer	$time
TeamSpeak3_Adapter_Abstract	$adapter

Returns:: void

TeamSpeak3_Helper_Signal_Interface::onException ( TeamSpeak3_Exception $ e )

Possible callback for 'errorException' signals.

=== Examples ===

TeamSpeak3_Helper_Signal::getInstance()->subscribe("errorException", array($object, "onException"));

Parameters:

TeamSpeak3_Exception $e

Returns:: void

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

libraries/TeamSpeak3/Helper/Signal/Interface.php

Public Member Functions

Detailed Description

Member Function Documentation