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.

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

doc: buffers are not sent over IPC with a socket #6951

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
doc: buffers are not sent over IPC with a socket
If a socket is sent to a child, any data that is buffered in the socket
will not be sent to the child. The child will only receive data from the
socket that is sent after the child has the socket.
Tim Kuijsten committed May 24, 2016
commit 9bccd72b7bb1a246a7af8a667062e78acd580d0a
3 changes: 2 additions & 1 deletion doc/api/child_process.md
Original file line number Diff line number Diff line change
@@ -856,7 +856,8 @@ Applications should avoid using such messages or listening for
The optional `sendHandle` argument that may be passed to `child.send()` is for
passing a TCP server or socket object to the child process. The child will
receive the object as the second argument passed to the callback function
registered on the [`process.on('message')`][] event.
registered on the [`process.on('message')`][] event. Any data that is received
and buffered in the socket will not be sent to the child.

The `options` argument, if present, is an object used to parameterize the
sending of certain types of handles. `options` supports the following