Socket - soundworks

Constructor

new Socket()

Source:

client/Socket.js, line 45

See:

Methods

addBinaryListener(channel, callback)

Source:

client/Socket.js, line 293

Listen binary messages on a given channel

Parameters:

Name	Type	Description
`channel`	String	Channel of the message
`callback`	function	Callback to execute when a message is received

addListener(channel, callback)

Source:

client/Socket.js, line 253

Listen JSON compatible messages on a given channel

Parameters:

Name	Type	Description
`channel`	String	Channel of the message
`callback`	function	Callback to execute when a message is received

removeAllBinaryListeners(channel)

Source:

client/Socket.js, line 312

Remove all listeners from binary compatible messages on a given channel

Parameters:

Name	Type	Description
`channel`	String	Channel of the message

removeAllListeners(channel)

Source:

client/Socket.js, line 272

Remove all listeners from JSON compatible messages on a given channel

Parameters:

Name	Type	Description
`channel`	String	Channel of the message

removeBinaryListener(channel, callback)

Source:

client/Socket.js, line 303

Remove a listener from binary compatible messages on a given channel

Parameters:

Name	Type	Description
`channel`	String	Channel of the message
`callback`	function	Callback to cancel

removeListener(channel, callback)

Source:

client/Socket.js, line 263

Remove a listener from JSON compatible messages on a given channel

Parameters:

Name	Type	Description
`channel`	String	Channel of the message
`callback`	function	Callback to remove

send(channel, …args)

Source:

client/Socket.js, line 242

Send JSON compatible messages on a given channel

Parameters:

Name	Type	Attributes	Description
`channel`	String		The channel of the message
`args`	*	<repeatable>	Arguments of the message (as many as needed, of any type)

sendBinary(channel, typedArray)

Source:

client/Socket.js, line 282

Send binary messages on a given channel

Parameters:

Name	Type	Description
`channel`	String	Channel of the message
`typedArray`	TypedArray	Data to send

terminate()

Source:

client/Socket.js, line 319

Immediately close the 2 sockets