Skip to content

Commit

Permalink
doc: document socket.destroyed
Browse files Browse the repository at this point in the history
Fixes: #5898
PR-URL: #6128
Reviewed-By: Colin Ihrig <[email protected]>
  • Loading branch information
tusharmath authored and Myles Borins committed Jul 14, 2016
1 parent a3fa5db commit 5380743
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,11 @@ with options either as either `{port: port, host: host}` or `{path: path}`.
Ensures that no more I/O activity happens on this socket. Only necessary in
case of errors (parse error or so).

### socket.destroyed

A Boolean value that indicates if the connection is destroyed or not. Once a
connection is destroyed no further data can be transferred using it.

### socket.end([data][, encoding])

Half-closes the socket. i.e., it sends a FIN packet. It is possible the
Expand Down

0 comments on commit 5380743

Please sign in to comment.