summaryrefslogtreecommitdiff
path: root/doc/api/cluster.md
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2016-07-22 12:05:27 -0400
committercjihrig <cjihrig@gmail.com>2016-08-01 15:08:42 -0400
commit75c6d9dd95bbdb926d84cb3a9f518eff88651709 (patch)
tree7d44b6f88a3027f1799d47115c344e871ac4dcf7 /doc/api/cluster.md
parent6d9a500064dc7e7df2491b1bed4555e8c53b4db2 (diff)
downloadandroid-node-v8-75c6d9dd95bbdb926d84cb3a9f518eff88651709.tar.gz
android-node-v8-75c6d9dd95bbdb926d84cb3a9f518eff88651709.tar.bz2
android-node-v8-75c6d9dd95bbdb926d84cb3a9f518eff88651709.zip
cluster: support stdio option for workers
This commit allows setupMaster() to configure the stdio channels for worker processes. Refs: https://github.com/nodejs/node-v0.x-archive/issues/5727 Refs: https://github.com/nodejs/node/pull/7811 PR-URL: https://github.com/nodejs/node/pull/7838 Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/cluster.md')
-rw-r--r--doc/api/cluster.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/api/cluster.md b/doc/api/cluster.md
index 6f0b424e05..616be9b59a 100644
--- a/doc/api/cluster.md
+++ b/doc/api/cluster.md
@@ -626,6 +626,9 @@ values are `"rr"` and `"none"`.
(Default=`process.argv.slice(2)`)
* `silent` {Boolean} whether or not to send output to parent's stdio.
(Default=`false`)
+ * `stdio` {Array} Configures the stdio of forked processes. Because the
+ cluster module relies on IPC to function, this configuration must contain an
+ `'ipc'` entry. When this option is provided, it overrides `silent`.
* `uid` {Number} Sets the user identity of the process. (See setuid(2).)
* `gid` {Number} Sets the group identity of the process. (See setgid(2).)
@@ -642,6 +645,8 @@ This object is not supposed to be changed or set manually, by you.
(Default=`process.argv.slice(2)`)
* `silent` {Boolean} whether or not to send output to parent's stdio.
(Default=`false`)
+ * `stdio` {Array} Configures the stdio of forked processes. When this option
+ is provided, it overrides `silent`.
`setupMaster` is used to change the default 'fork' behavior. Once called,
the settings will be present in `cluster.settings`.