Worker

external class Worker : EventEmitter(source)

A Worker object contains all public information and method about a worker. In the primary it can be obtained using cluster.workers. In a worker it can be obtained using cluster.worker.

Since

v0.7.0

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

This property is true if the worker exited due to .disconnect(). If the worker exited any other way, it is false. If the worker has not exited, it is undefined.

Link copied to clipboard
Link copied to clipboard
var id: Double

Each new worker is given its own unique id, this id is stored in the id.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

All workers are created using child_process.fork(), the returned object from this function is stored as .process. In a worker, the global process is stored.

Functions

Link copied to clipboard
fun addListener(event: String, listener: Function<Unit>)

events.EventEmitter

fun addListener(type: EventType, listener: EventListener)

Alias for emitter.on(eventName, listener).

Link copied to clipboard
fun destroy(signal: String = definedExternally)
Link copied to clipboard

In a worker, this function will close all servers, wait for the 'close' event on those servers, and then disconnect the IPC channel.

Link copied to clipboard
fun emit(event: Symbol, vararg args: Any?): Boolean
fun emit(event: String, vararg args: Any?): Boolean

fun emit(type: EventType, vararg args: Any?): Boolean

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Link copied to clipboard

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

Link copied to clipboard

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to {@link defaultMaxListeners}.

Link copied to clipboard

This function returns true if the worker is connected to its primary via its IPC channel, false otherwise. A worker is connected to its primary after it has been created. It is disconnected after the 'disconnect' event is emitted.

Link copied to clipboard

This function returns true if the worker's process has terminated (either because of exiting or being signaled). Otherwise, it returns false.

Link copied to clipboard
fun kill(signal: String = definedExternally)

This function will kill the worker. In the primary worker, it does this by disconnecting the worker.process, and once disconnected, killing with signal. In the worker, it does it by killing the process with signal.

Link copied to clipboard
fun listenerCount(type: EventType, listener: EventListener = definedExternally): Double

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Link copied to clipboard

Returns a copy of the array of listeners for the event named eventName.

Link copied to clipboard
fun off(type: EventType, listener: EventListener)

Alias for emitter.removeListener().

Link copied to clipboard
fun on(event: String, listener: Function<Unit>)

fun on(type: EventType, listener: EventListener)

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Link copied to clipboard
fun once(event: String, listener: Function<Unit>)

fun once(type: EventType, listener: EventListener)

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

Link copied to clipboard
fun prependListener(event: String, listener: Function<Unit>)

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

Link copied to clipboard
fun prependOnceListener(event: String, listener: Function<Unit>)

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

Link copied to clipboard

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

Link copied to clipboard
fun removeAllListeners(type: EventType = definedExternally)

Removes all listeners, or those of the specified eventName.

Link copied to clipboard
fun removeListener(type: EventType, listener: EventListener)

Removes the specified listener from the listener array for the event named eventName.

Link copied to clipboard
fun send(message: Serializable, callback: (JsError?) -> Unit = definedExternally): Boolean

Send a message to a worker or primary, optionally with a handle.

fun send(message: Serializable, sendHandle: SendHandle, callback: (JsError?) -> Unit = definedExternally): Boolean
fun send(message: Serializable, sendHandle: SendHandle, options: MessageOptions = definedExternally, callback: (JsError?) -> Unit = definedExternally): Boolean
Link copied to clipboard

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.