TeamSpeak3_Helper_Signal_Interface Class Reference

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

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

Detailed Description

Interface class describing the layout for TeamSpeak3_Helper_Signal callbacks.

Member Function Documentation

onCommandFinished()

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

onCommandStarted()

onCommandStarted

(

$cmd

)

Possible callback for 'serverqueryCommandStarted' signals.

=== Examples ===

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

Parameters

string

$cmd

Returns

void

onConnect()

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"));

Parameters

TeamSpeak3_Adapter_Abstract

$adapter

Returns

void

onDebugDataRead()

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"));

Parameters

string

$data

Returns

void

onDebugDataSend()

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"));

Parameters

string

$data

Returns

void

onDisconnect()

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"));

Returns

void

onError()

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

onEvent()

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

onException()

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

onFtDownloadFinished()

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

onFtDownloadProgress()

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

onFtDownloadStarted()

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

onFtHandshake()

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

onFtUploadFinished()

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

onFtUploadProgress()

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

onFtUploadStarted()

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

onLogin()

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

onLogout()

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

onServercreated()

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

onServerdeleted()

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

onServerselected()

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

onServershutdown()

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

onServerstarted()

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

onServerstopped()

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

onTokencreated()

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

onWaitTimeout()

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"));

Parameters

integer	$time
TeamSpeak3_Adapter_Abstract	$adapter

Returns

void

---

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

• /Volumes/home/Repositories/planetteamspeak/ts3phpframework/libraries/TeamSpeak3/Helper/Signal/Interface.php