Worker
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
Properties
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
.
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
events.EventEmitter
Alias for emitter.on(eventName, listener)
.
In a worker, this function will close all servers, wait for the 'close'
event on those servers, and then disconnect the IPC channel.
Synchronously calls each of the listeners registered for the event named eventName
, in the order they were registered, passing the supplied arguments to each.
Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbol
s.
Returns the current max listener value for the EventEmitter
which is either set by emitter.setMaxListeners(n)
or defaults to {@link defaultMaxListeners}.
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.
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.
Returns a copy of the array of listeners for the event named eventName
.
Alias for emitter.removeListener()
.
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.
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.
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.
Returns a copy of the array of listeners for the event named eventName
, including any wrappers (such as those created by .once()
).
Removes all listeners, or those of the specified eventName
.
Removes the specified listener
from the listener array for the event named eventName
.
Send a message to a worker or primary, optionally with a handle.
By default EventEmitter
s 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.