Skip to content

doc: various improvements to net.md #11636

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

Closed
joyeecheung wants to merge 7 commits into from
Closed

doc: various improvements to net.md #11636

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f6860a9
doc: various improvements to net.md
joyeecheung Mar 1, 2017
d1ea3d2
add stream-based
joyeecheung Mar 1, 2017
5896e3e
socket(7), wrap links, arbitrary port
joyeecheung Mar 1, 2017
5102522
fix line wrap
joyeecheung Mar 1, 2017
b78b5f3
fix link sort order
joyeecheung Mar 3, 2017
fb61a63
address comments
joyeecheung Mar 3, 2017
3686d75
fix wrap
joyeecheung Mar 3, 2017
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
Prev Previous commit
Next Next commit
address comments
  • Loading branch information
@joyeecheung
joyeecheung committed Mar 3, 2017
commit fb61a637559fc79c26817f6b8ff2dba7a9a33b36
16 changes: 10 additions & 6 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
> Stability: 2 - Stable

The `net` module provides an asynchronous network API for creating stream-based
servers ([`net.Server`][]) and clients ([`net.Socket`][]) that implement TCP
servers ([`net.createServer()`][]) and clients ([`net.createConnection()`][]) that implement TCP
or local communications (domain sockets on UNIX, named pipes on Windows).
It can be accessed using:

Expand Down Expand Up @@ -155,7 +155,8 @@ on Linux. The default value of this parameter is 511 (not 512).

Note:

* All [`net.Socket`][] are set to `SO_REUSEADDR`(See [socket(7)][] for details).
* All [`net.Socket`][] are set to `SO_REUSEADDR` (See [socket(7)][] for
details).
* The `server.listen()` method may be called multiple times. Each
subsequent call will *re-open* the server using the provided options.

Expand Down Expand Up @@ -405,14 +406,16 @@ See also: the return values of `socket.write()`
added: v0.1.90
-->

Emitted when the other end of the socket sends a FIN packet.
Emitted when the other end of the socket sends a FIN packet, thus ending the
readable side of the socket.

By default (`allowHalfOpen` is `false`) the socket will send a FIN packet
back and destroy its file descriptor once it has written out its pending
write queue. However, if `allowHalfOpen` is set to `true`, the socket will
not automatically [`end()`][`socket.end()`] its side, allowing the user to
write arbitrary amounts of data. The user must call [`end()`][`socket.end()`]
explicitly to close the connection.
not automatically [`end()`][`socket.end()`] its writable side, allowing the
user to write arbitrary amounts of data. The user must call
[`end()`][`socket.end()`] explicitly to close the connection (i.e. sending a
FIN packet back).

### Event: 'error'
<!-- YAML
Expand Down Expand Up @@ -978,6 +981,7 @@ Returns true if input is a version 6 IP address, otherwise returns false.
[`dns.lookup()`]: dns.html#dns_dns_lookup_hostname_options_callback
[`dns.lookup()` hints]: dns.html#dns_supported_getaddrinfo_flags
[`EventEmitter`]: events.html#events_class_eventemitter
[`net.createConnection()`]: #net_net_createconnection_options_connectlistener
[`net.createServer()`]: #net_net_createserver_options_connectionlistener
[`net.Server`]: #net_class_net_server
[`net.Socket`]: #net_class_net_socket
Expand Down