aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorWitold Kręcicki <wpk@isc.org>2019-11-30 00:53:02 +0100
committerSaúl Ibarra Corretgé <s@saghul.net>2020-01-31 11:09:16 +0100
commita629688008694ed8022269e66826d4d6ec688b83 (patch)
tree9afd1456aafb48d3a71b284afb22d749c8bcbbba /docs/src
parent1ff84206613e17e4d2242b96e3b6be7288840043 (diff)
downloadlibuv-a629688008694ed8022269e66826d4d6ec688b83.tar.gz
libuv-a629688008694ed8022269e66826d4d6ec688b83.zip
pipe: disallow listening on an IPC pipe
PR-URL: https://github.com/libuv/libuv/pull/2559 Reviewed-By: Jameson Nash <vtjnash@gmail.com> Reviewed-By: Saúl Ibarra Corretgé <s@saghul.net>
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/pipe.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/src/pipe.rst b/docs/src/pipe.rst
index 5eac1b6d..6437a9d9 100644
--- a/docs/src/pipe.rst
+++ b/docs/src/pipe.rst
@@ -24,6 +24,8 @@ Public members
.. c:member:: int uv_pipe_t.ipc
Whether this pipe is suitable for handle passing between processes.
+ Only a connected pipe that will be passing the handles should have this flag
+ set, not the listening pipe that uv_accept is called on.
.. seealso:: The :c:type:`uv_stream_t` members also apply.
@@ -35,7 +37,9 @@ API
Initialize a pipe handle. The `ipc` argument is a boolean to indicate if
this pipe will be used for handle passing between processes (which may
- change the bytes on the wire).
+ change the bytes on the wire). Only a connected pipe that will be
+ passing the handles should have this flag set, not the listening pipe
+ that uv_accept is called on.
.. c:function:: int uv_pipe_open(uv_pipe_t* handle, uv_file file)