Methods
addListener(channel, callback)
- Description:
Listen messages with JSON compatible data types on a given channel.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
channel |
string | Channel name. |
callback |
function | Callback to execute when a message is received, arguments of the callback function will match the arguments sent using the ServerSocket#send method. |
(async) kSocketTerminate()
- Description:
Removes all listeners and immediately close the two sockets. Is automatically called on
client.stop()Is also called when a disconnection is detected by the heartbeat (note that in this case, the launcher will call
client.stop()but the listeners are already cleared so the event will be trigerred only once.
- Source:
removeAllListeners(channel)
- Description:
Remove all listeners of messages with JSON compatible data types.
- Source:
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
channel |
string |
null
|
Channel name. |
removeListener(channel, callback)
- Description:
Remove a listener from JSON compatible messages on a given channel.
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
channel |
string | Channel name. |
callback |
function | Callback to remove. |
send(channel, …args)
- Description:
Send messages with JSON compatible data types on a given channel.
- Source:
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
channel |
string | Channel name. |
|
args |
* |
<repeatable> |
Payload of the message. As many arguments as needed, of JSON compatible data types (i.e. string, number, boolean, object, array and null). |