Skip to content

Commit 5207526

Browse files
Tim Kuijstenaddaleax
Tim Kuijsten
authored andcommitted
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 bddfe63 commit 5207526

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
@@ -913,7 +913,8 @@ Applications should avoid using such messages or listening for
913913
The optional `sendHandle` argument that may be passed to `child.send()` is for
914914
passing a TCP server or socket object to the child process. The child will
915915
receive the object as the second argument passed to the callback function
916-
registered on the [`process.on('message')`][] event.
916+
registered on the [`process.on('message')`][] event. Any data that is received
917+
and buffered in the socket will not be sent to the child.
917918

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

0 commit comments

Comments
 (0)