\ManiaControl\CallbacksEchoManager

Class for managing Echo Callbacks

Summary

Methods
Properties
Constants
getUsageInformation()
__construct()
sendEcho()
registerEchoListener()
unregisterEchoListener()
triggerEchoCallback()
handleEchos()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
removeEchoListener()
$maniaControl
$echoListenings
N/A

Properties

Methods

getUsageInformation()

getUsageInformation() 

Gets Information about the Class, and a List of the Public Method

__construct()

__construct(\ManiaControl\ManiaControl  $maniaControl) 

Create a new Echo Handler Instance

Parameters

\ManiaControl\ManiaControl $maniaControl

sendEcho()

sendEcho(string  $name, mixed  $data) : boolean

Sends an Echo Message

Parameters

string $name
mixed $data

(can be array, object or string)

Throws

\Maniaplanet\DedicatedServer\InvalidArgumentException

Returns

boolean

registerEchoListener()

registerEchoListener(  $echoName, \ManiaControl\Callbacks\EchoListener  $listener, string  $method) : boolean

Register a new Echo Listener

Parameters

$echoName
\ManiaControl\Callbacks\EchoListener $listener
string $method

Returns

boolean

unregisterEchoListener()

unregisterEchoListener(\ManiaControl\Callbacks\EchoListener  $listener) : boolean

Unregister a Echo Listener

Parameters

\ManiaControl\Callbacks\EchoListener $listener

Returns

boolean

triggerEchoCallback()

triggerEchoCallback(  $callbackName) 

Trigger a specific Callback

Parameters

$callbackName

handleEchos()

handleEchos(  $param) 

Handle the given Callback

Parameters

$param

removeEchoListener()

removeEchoListener(array<mixed,\ManiaControl\Callbacks\Listening>  $listeningsArray, \ManiaControl\Callbacks\EchoListener  $listener) : boolean

Remove the Echo Listener from the given Listeners Array

Parameters

array<mixed,\ManiaControl\Callbacks\Listening> $listeningsArray
\ManiaControl\Callbacks\EchoListener $listener

Returns

boolean