Skip to content

Commit 1e86d16

Browse files
Tim KuijstenMyles Borins
Tim Kuijsten
authored and
Myles Borins
committed
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. PR-URL: #6951 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent 5c1d8e1 commit 1e86d16

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

doc/api/child_process.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -896,7 +896,8 @@ Applications should avoid using such messages or listening for
896896
The optional `sendHandle` argument that may be passed to `child.send()` is for
897897
passing a TCP server or socket object to the child process. The child will
898898
receive the object as the second argument passed to the callback function
899-
registered on the `process.on('message')` event.
899+
registered on the `process.on('message')` event. Any data that is received and
900+
buffered in the socket will not be sent to the child.
900901

901902
The optional `callback` is a function that is invoked after the message is
902903
sent but before the child may have received it. The function is called with a

0 commit comments

Comments
 (0)