Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: server close event does not have an argument #1025

Closed
wants to merge 3 commits into from
Closed

doc: server close event does not have an argument #1025

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5059401
doc: server close event does not have an argument
sam-github Mar 2, 2015
ad1df21
fixup
sam-github Jul 18, 2015
cad0cb3
doc: a listener, not "an" listener
sam-github Jul 28, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions doc/api/net.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ The options are passed to both the ['net.Socket'](#net_class_net_socket)
constructor and the ['socket.connect'](#net_socket_connect_options_connectlistener)
method.

The `connectListener` parameter will be added as an listener for the
The `connectListener` parameter will be added as a listener for the
['connect'][] event.

Here is an example of a client of the previously described echo server:
Expand Down Expand Up @@ -100,7 +100,7 @@ supplied `port` and `host`.

If `host` is omitted, `'localhost'` will be assumed.

The `connectListener` parameter will be added as an listener for the
The `connectListener` parameter will be added as a listener for the
['connect'][] event.

## net.connect(path[, connectListener])
Expand All @@ -110,7 +110,7 @@ A factory function, which returns a new unix
['net.Socket'](#net_class_net_socket) and automatically connects to the
supplied `path`.

The `connectListener` parameter will be added as an listener for the
The `connectListener` parameter will be added as a listener for the
['connect'][] event.

## Class: net.Server
Expand All @@ -131,7 +131,7 @@ parameter is 511 (not 512).

This function is asynchronous. When the server has been bound,
['listening'][] event will be emitted. The last parameter `callback`
will be added as an listener for the ['listening'][] event.
will be added as a listener for the ['listening'][] event.

One issue some users run into is getting `EADDRINUSE` errors. This means that
another server is already running on the requested port. One way of handling this
Expand Down Expand Up @@ -193,7 +193,7 @@ Listening on a file descriptor is not supported on Windows.

This function is asynchronous. When the server has been bound,
['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 a listener for the
['listening'][] event.

### server.listen(options[, callback])
Expand Down Expand Up @@ -228,10 +228,10 @@ shown below.

Stops the server from accepting new connections and keeps existing
connections. This function is asynchronous, the server is finally
closed when all connections are ended and the server emits a `'close'`
event. Optionally, you can pass a callback to listen for the `'close'`
event. If present, the callback is invoked with any potential error
as the first and only argument.
closed when all connections are ended and the server emits a ['close'][] event.
The optional `callback` will be called once the `'close'` event occurs. Unlike
that event, it will be called with an Error as its only argument if the server
was not open when it was closed.

### server.address()

Expand Down Expand Up @@ -313,7 +313,7 @@ event is not emitted until all connections are ended.

* {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`.

## Class: net.Socket
Expand Down Expand Up @@ -368,7 +368,7 @@ This function is asynchronous. When the ['connect'][] event is emitted the
socket is established. If there is a problem connecting, the `'connect'` event
will not be emitted, the `'error'` event will be emitted with the exception.

The `connectListener` parameter will be added as an listener for the
The `connectListener` parameter will be added as a listener for the
['connect'][] event.

### socket.connect(port[, host][, connectListener])
Expand Down Expand Up @@ -581,7 +581,7 @@ following this event.

### 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
which says if the socket was closed due to a transmission error.
Expand All @@ -601,6 +601,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.

['close']: #net_event_close
['connect']: #net_event_connect
['connection']: #net_event_connection
['end']: #net_event_end
Expand Down