diff options
| author | Paul Evans <leonerd@leonerd.org.uk> | 2022-02-14 16:37:19 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-14 11:37:19 -0500 |
| commit | 722d003076c5a4b985c4d52db1eb3fd073c8b1cc (patch) | |
| tree | db16f2cc03d81be90b99ecd99e015a967acd6475 /docs/src | |
| parent | df78de04e46a8dbe341f418052238da0141a69af (diff) | |
| download | libuv-722d003076c5a4b985c4d52db1eb3fd073c8b1cc.tar.gz libuv-722d003076c5a4b985c4d52db1eb3fd073c8b1cc.zip | |
document the values of enum uv_stdio_flags (#3039)
Co-authored-by: Jameson Nash <vtjnash@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/process.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/src/process.rst b/docs/src/process.rst index ea6c4b9a..8acf7db3 100644 --- a/docs/src/process.rst +++ b/docs/src/process.rst @@ -109,10 +109,39 @@ Data types :: typedef enum { + /* + * The following four options are mutually-exclusive, and define + * the operation to perform for the corresponding file descriptor + * in the child process: + */ + + /* + * No file descriptor will be provided (or redirected to + * `/dev/null` if it is fd 0, 1 or 2). + */ UV_IGNORE = 0x00, + + /* + * Open a new pipe into `data.stream`, per the flags below. The + * `data.stream` field must point to a uv_pipe_t object that has + * been initialized with `uv_pipe_init(loop, data.stream, ipc);`, + * but not yet opened or connected. + /* UV_CREATE_PIPE = 0x01, + + /* + * The child process will be given a duplicate of the parent's + * file descriptor given by `data.fd`. + */ UV_INHERIT_FD = 0x02, + + /* + * The child process will be given a duplicate of the parent's + * file descriptor being used by the stream handle given by + * `data.stream`. + */ UV_INHERIT_STREAM = 0x04, + /* * When UV_CREATE_PIPE is specified, UV_READABLE_PIPE and UV_WRITABLE_PIPE * determine the direction of flow, from the child process' perspective. Both @@ -120,6 +149,7 @@ Data types */ UV_READABLE_PIPE = 0x10, UV_WRITABLE_PIPE = 0x20, + /* * When UV_CREATE_PIPE is specified, specifying UV_NONBLOCK_PIPE opens the * handle in non-blocking mode in the child. This may cause loss of data, |