IPC

The main hub for recieving messages and interacting with other clusters.

Constructor

new Client(cid, max);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
cid	number	❌	undefined	Cluster ID.
max	number?	✔️	50	Max number of listeners.

Methods

send

Sends an IPC event to all clusters. This will trigger all listeners for given event on all clusters with given arguments.

note

Any arguments given will become dereferenced so ensure any references are deep cloned.

send(event, ...args);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to envoke listeners from.
args	any[]?	✔️	undefined	Arguments to pass through CallableFunction.

Returns

void

---

sendTo

Sends an IPC event to a certain cluster. This will trigger all listeners for given event on given cluster with given arguments.

note

Any arguments given will become dereferenced so ensure any references are deep cloned.

send(cluster, event, ...args);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
cluster	number	❌	undefined	Id of cluster to send to.
event	string	❌	undefined	Event name to envoke listeners from.
args	any[]?	✔️	undefined	Arguments to pass through CallableFunction.

Returns

void

---

addListener

Add a new listener to be synchronously called on an event.

addListener(event, listener);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to add listener to.
listener	CallableFunction	❌	undefined	Function to execute.

Returns

void

---

removeListener

Removes a previously registered listener from an event.

removeListener(event, listener);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to remove listener from.
listener	CallableFunction	❌	undefined	Function that was given.

Returns

void

---

removeListeners

Remove all previously registered listeners from an event.

removeListeners(event);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to remove listeners from.

Returns

void

---

removeAllListeners

Removes all previously registered listeners from all event.

removeAllListeners();

Returns

void

---

envokeEvent

Envokes all listeners to be synchronously called on an event.

envokeEvent(event, ...args);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to envoke listeners from.
args	any[]?	✔️	undefined	Arguments to pass through CallableFunction.

Returns

void

---

listeners

Returns an array of all listeners on an event.

listeners(event);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to get listeners from.

Returns

CallableFunction[] | undefined

---

listenerCount

Returns number of listeners on an event.

listenerCount(event);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to get amount of listeners from.

Returns

number

---

getMaxListeners

Returns the max amount of listeners before mem leak warning occurs.

getMaxListeners();

Returns

number

---

setMaxListeners

Returns the max amount of listeners before mem leak warning occurs.

setMaxListeners(amount);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
amount	number	❌	undefined	New amount of listeners before mem leak warning.

Returns

void

---

on

Add a new listener to be synchronously called on an event.

on(event, listener);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to add listener to.
listener	CallableFunction	❌	undefined	Function to execute.

Returns

void

---

once

Similar to on however after being called once it cannot be called again.

once(event, listener);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to add listener to.
listener	CallableFunction	❌	undefined	Function to execute.

Returns

void

---

off

Removes a previously registered listener from an event.

removeListener(event, listener);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to remove listener from.
listener	CallableFunction	❌	undefined	Function that was given.

Returns

void

---

emit

Envokes all listeners to be synchronously called on an event.

envokeEvent(event, ...args);

PARAMETER	TYPE	OPTIONAL	DEFAULT	DESCRIPTION
event	string	❌	undefined	Event name to envoke listeners from.
args	any[]?	✔️	undefined	Arguments to pass through CallableFunction.

Returns

void

---