Skip to content

doc: improve net docs #32811

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
ronag wants to merge 7 commits into from
Closed

doc: improve net docs #32811

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
24d420a
doc: improve net docs
ronag Apr 13, 2020
a3715af
Apply suggestions from code review
ronag Apr 13, 2020
f14c446
fixup: fix link
ronag Apr 13, 2020
f63e0c9
fixup: remove misleading comment
ronag Apr 13, 2020
b70cdcf
fixup: add note regarding TCP rst
ronag Apr 13, 2020
c7837ad
fixup: apply suggestion
ronag Apr 13, 2020
9047905
Update doc/api/net.md
ronag Apr 13, 2020
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
21 changes: 12 additions & 9 deletions doc/api/net.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -722,25 +722,26 @@ that the
[`socket.connect(options[, connectListener])`][`socket.connect(options)`]
callback is a listener for the `'connect'` event.

### `socket.destroy([exception])`
### `socket.destroy([error])`
<!-- YAML
added: v0.1.90
-->

* `exception` {Object}
* `error` {Object}
* Returns: {net.Socket}

Ensures that no more I/O activity happens on this socket. Only necessary in
case of errors (parse error or so).
Ensures that no more I/O activity happens on this socket. This destroys
the stream but does not explicitly cause a TCP stream reset (RST).
Copy link
Copy Markdown
Member Author

@ronag ronag Apr 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lpinca: please note updated version, better?

Copy link
Copy Markdown
Member

@lpinca lpinca Apr 13, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would honestly not add those details that I think are confusing for most users. "Destroys the stream and closes the connection" is enough. Interested users can dig by themselves to see what happens under the hood.

Copy link
Copy Markdown
Member Author

@ronag ronag Apr 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to your suggestion.


If `exception` is specified, an [`'error'`][] event will be emitted and any
listeners for that event will receive `exception` as an argument.
See, [`writable.destroy()`][] for further details.
Comment thread
ronag marked this conversation as resolved.
Outdated

### `socket.destroyed`

* {boolean} Indicates if the connection is destroyed or not. Once a
connection is destroyed no further data can be transferred using it.

See [`writable.destroyed`][] for further details.

### `socket.end([data[, encoding]][, callback])`
<!-- YAML
added: v0.1.90
Expand All @@ -754,8 +755,7 @@ added: v0.1.90
Half-closes the socket. i.e., it sends a FIN packet. It is possible the
server will still send some data.

If `data` is specified, it is equivalent to calling
`socket.write(data, encoding)` followed by [`socket.end()`][].
See [`writable.end()`][] for further details.

### `socket.localAddress`
<!-- YAML
Expand Down Expand Up @@ -1261,13 +1261,16 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`.
[`socket.connect(path)`]: #net_socket_connect_path_connectlistener
[`socket.connect(port)`]: #net_socket_connect_port_host_connectlistener
[`socket.connecting`]: #net_socket_connecting
[`socket.destroy()`]: #net_socket_destroy_exception
[`socket.destroy()`]: #net_socket_destroy_error
[`socket.end()`]: #net_socket_end_data_encoding_callback
[`socket.pause()`]: #net_socket_pause
[`socket.resume()`]: #net_socket_resume
[`socket.setEncoding()`]: #net_socket_setencoding_encoding
[`socket.setTimeout()`]: #net_socket_settimeout_timeout_callback
[`socket.setTimeout(timeout)`]: #net_socket_settimeout_timeout_callback
[`writable.destroyed`]: stream.html#stream_writable_destroyed
[`writable.destroy()`]: stream.html#stream_writable_destroy_error
[`writable.end()`]: stream.html#stream_writable_end_chunk_encoding_callback
[half-closed]: https://tools.ietf.org/html/rfc1122
[stream_writable_write]: stream.html#stream_writable_write_chunk_encoding_callback
[unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0
Expand Down