Browse Source

doc: server close event does not have an argument

Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: https://github.com/nodejs/io.js/pull/1025
v4.0.0-rc
Sam Roberts 10 years ago
parent
commit
54627a919d
  1. 15
      doc/api/net.markdown

15
doc/api/net.markdown

@ -193,7 +193,7 @@ Listening on a file descriptor is not supported on Windows.
This function is asynchronous. When the server has been bound, This function is asynchronous. When the server has been bound,
['listening'][] event will be emitted. ['listening'][] event will be emitted.
the last parameter `callback` will be added as an listener for the The last parameter `callback` will be added as an listener for the
['listening'][] event. ['listening'][] event.
### server.listen(options[, callback]) ### server.listen(options[, callback])
@ -228,10 +228,10 @@ shown below.
Stops the server from accepting new connections and keeps existing Stops the server from accepting new connections and keeps existing
connections. This function is asynchronous, the server is finally connections. This function is asynchronous, the server is finally
closed when all connections are ended and the server emits a `'close'` closed when all connections are ended and the server emits a ['close'][] event.
event. Optionally, you can pass a callback to listen for the `'close'` The optional `callback` will be called once the `'close'` event occurs. Unlike
event. If present, the callback is invoked with any potential error that event, it will be called with an Error as its only argument if the server
as the first and only argument. was not open when it was closed.
### server.address() ### server.address()
@ -317,7 +317,7 @@ event is not emitted until all connections are ended.
* {Error Object} * {Error Object}
Emitted when an error occurs. The `'close'` event will be called directly Emitted when an error occurs. The ['close'][] event will be called directly
following this event. See example in discussion of `server.listen`. following this event. See example in discussion of `server.listen`.
## Class: net.Socket ## Class: net.Socket
@ -597,7 +597,7 @@ following this event.
### Event: 'close' ### Event: 'close'
* `had_error` {Boolean} true if the socket had a transmission error * `had_error` {Boolean} `true` if the socket had a transmission error.
Emitted once the socket is fully closed. The argument `had_error` is a boolean Emitted once the socket is fully closed. The argument `had_error` is a boolean
which says if the socket was closed due to a transmission error. which says if the socket was closed due to a transmission error.
@ -617,6 +617,7 @@ Returns true if input is a version 4 IP address, otherwise returns false.
Returns true if input is a version 6 IP address, otherwise returns false. Returns true if input is a version 6 IP address, otherwise returns false.
['close']: #net_event_close
['connect']: #net_event_connect ['connect']: #net_event_connect
['connection']: #net_event_connection ['connection']: #net_event_connection
['end']: #net_event_end ['end']: #net_event_end

Loading…
Cancel
Save