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

doc: document the address object in the cluster listening event

Browse Source
This commit is contained in:
Andreas Madsen 2012-04-28 14:24:17 +02:00 committed by Ben Noordhuis
parent 12a90e98bf
commit ab072ee416
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/api/cluster.markdown
View File

@ -109,13 +109,19 @@ being executed.
## Event: 'listening' ## Event: 'listening'
* `worker` {Worker object} * `worker` {Worker object}
* `address` {Object}
When calling `listen()` from a worker, a 'listening' event is automatically assigned When calling `listen()` from a worker, a 'listening' event is automatically assigned
to the server instance. When the server is listening a message is send to the master to the server instance. When the server is listening a message is send to the master
where the 'listening' event is emitted. where the 'listening' event is emitted.
cluster.on('listening', function (worker) { The event handler is executed with two arguments, the `worker` contains the worker
console.log("We are now connected"); object and the `address` object contains the following connection properties:
`address`, `port` and `addressType`. This is very useful if the worker is listening
on more than one address.
cluster.on('listening', function (worker, address) {
console.log("A worker is now connected to " + address.address + ":" + address.port);
}); });
## Event: 'disconnect' ## Event: 'disconnect'
@ -408,11 +414,12 @@ on the specified worker.
### Event: 'listening' ### Event: 'listening'
* `worker` {Worker object} * `worker` {Worker object}
* `address` {Object}
Same as the `cluster.on('listening')` event, but emits only when the state change Same as the `cluster.on('listening')` event, but emits only when the state change
on the specified worker. on the specified worker.
cluster.fork().on('listening', function (worker) { cluster.fork().on('listening', function (worker, address) {
// Worker is listening // Worker is listening
}; };