1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: fix cluster worker 'message' event

Browse Source 
This commit adds the missing handle argument to the cluster
worker 'message' event. It also adds a link to the process
'message' event for reference.

Refs: https://github.com/nodejs/node/pull/7297
PR-URL: https://github.com/nodejs/node/pull/7309
Reviewed-By: Brian White <mscdex@mscdex.net>
This commit is contained in:
cjihrig 2016-06-15 10:08:53 -04:00
parent dfcf02b6f7
commit 62c8e7b922
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/cluster.md
View File

@ -167,12 +167,12 @@ It is not emitted in the worker.
### Event: 'message' ### Event: 'message'
* `message` {Object} * `message` {Object}
* `handle` {undefined|Object}
Similar to the `cluster.on('message')` event, but specific to this worker. Similar to the `cluster.on('message')` event, but specific to this worker. In a
worker you can also use `process.on('message')`.
This event is the same as the one provided by [`child_process.fork()`][]. See [`process` event: `'message'`][].
In a worker you can also use `process.on('message')`.
As an example, here is a cluster that keeps count of the number of requests As an example, here is a cluster that keeps count of the number of requests
in the master process using the message system: in the master process using the message system:
@ -735,3 +735,4 @@ socket.on('data', (id) => {
[Child Process module]: child_process.html#child_process_child_process_fork_modulepath_args_options [Child Process module]: child_process.html#child_process_child_process_fork_modulepath_args_options
[child_process event: 'exit']: child_process.html#child_process_event_exit [child_process event: 'exit']: child_process.html#child_process_event_exit
[child_process event: 'message']: child_process.html#child_process_event_message [child_process event: 'message']: child_process.html#child_process_event_message
[`process` event: `'message'`]: process.html#process_event_message