summaryrefslogtreecommitdiff
path: root/deps/uv/docs
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2017-11-10 12:15:10 -0500
committercjihrig <cjihrig@gmail.com>2017-11-10 13:32:42 -0500
commit766cd1f59d5adb03953656391e63b4186c9aff10 (patch)
treebbcbb6ac69913e6fa60c971f68d62b090906719f /deps/uv/docs
parent6f02da255f803719cda330f69213ad9a11ef4b04 (diff)
downloadandroid-node-v8-766cd1f59d5adb03953656391e63b4186c9aff10.tar.gz
android-node-v8-766cd1f59d5adb03953656391e63b4186c9aff10.tar.bz2
android-node-v8-766cd1f59d5adb03953656391e63b4186c9aff10.zip
deps: upgrade libuv to 1.16.1
PR-URL: https://github.com/nodejs/node/pull/16835 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'deps/uv/docs')
-rw-r--r--deps/uv/docs/src/fs.rst151
-rw-r--r--deps/uv/docs/src/loop.rst3
-rw-r--r--deps/uv/docs/src/misc.rst66
-rw-r--r--deps/uv/docs/src/pipe.rst9
4 files changed, 229 insertions, 0 deletions
diff --git a/deps/uv/docs/src/fs.rst b/deps/uv/docs/src/fs.rst
index 2db915bc9e..f46c4e761a 100644
--- a/deps/uv/docs/src/fs.rst
+++ b/deps/uv/docs/src/fs.rst
@@ -353,3 +353,154 @@ Helper functions
any attempts to close it or to use it after closing the fd may lead to malfunction.
.. versionadded:: 1.12.0
+
+File open constants
+-------------------
+
+.. c:macro:: UV_FS_O_APPEND
+
+ The file is opened in append mode. Before each write, the file offset is
+ positioned at the end of the file.
+
+.. c:macro:: UV_FS_O_CREAT
+
+ The file is created if it does not already exist.
+
+.. c:macro:: UV_FS_O_DIRECT
+
+ File I/O is done directly to and from user-space buffers, which must be
+ aligned. Buffer size and address should be a multiple of the physical sector
+ size of the block device.
+
+ .. note::
+ `UV_FS_O_DIRECT` is supported on Linux, and on Windows via
+ `FILE_FLAG_NO_BUFFERING <https://msdn.microsoft.com/en-us/library/windows/desktop/cc644950.aspx>`_.
+ `UV_FS_O_DIRECT` is not supported on macOS.
+
+.. c:macro:: UV_FS_O_DIRECTORY
+
+ If the path is not a directory, fail the open.
+
+ .. note::
+ `UV_FS_O_DIRECTORY` is not supported on Windows.
+
+.. c:macro:: UV_FS_O_DSYNC
+
+ The file is opened for synchronous I/O. Write operations will complete once
+ all data and a minimum of metadata are flushed to disk.
+
+ .. note::
+ `UV_FS_O_DSYNC` is supported on Windows via
+ `FILE_FLAG_WRITE_THROUGH <https://msdn.microsoft.com/en-us/library/windows/desktop/cc644950.aspx>`_.
+
+.. c:macro:: UV_FS_O_EXCL
+
+ If the `O_CREAT` flag is set and the file already exists, fail the open.
+
+ .. note::
+ In general, the behavior of `O_EXCL` is undefined if it is used without
+ `O_CREAT`. There is one exception: on Linux 2.6 and later, `O_EXCL` can
+ be used without `O_CREAT` if pathname refers to a block device. If the
+ block device is in use by the system (e.g., mounted), the open will fail
+ with the error `EBUSY`.
+
+.. c:macro:: UV_FS_O_EXLOCK
+
+ Atomically obtain an exclusive lock.
+
+ .. note::
+ `UV_FS_O_EXLOCK` is only supported on macOS.
+
+.. c:macro:: UV_FS_O_NOATIME
+
+ Do not update the file access time when the file is read.
+
+ .. note::
+ `UV_FS_O_NOATIME` is not supported on Windows.
+
+.. c:macro:: UV_FS_O_NOCTTY
+
+ If the path identifies a terminal device, opening the path will not cause
+ that terminal to become the controlling terminal for the process (if the
+ process does not already have one).
+
+ .. note::
+ `UV_FS_O_NOCTTY` is not supported on Windows.
+
+.. c:macro:: UV_FS_O_NOFOLLOW
+
+ If the path is a symbolic link, fail the open.
+
+ .. note::
+ `UV_FS_O_NOFOLLOW` is not supported on Windows.
+
+.. c:macro:: UV_FS_O_NONBLOCK
+
+ Open the file in nonblocking mode if possible.
+
+ .. note::
+ `UV_FS_O_NONBLOCK` is not supported on Windows.
+
+.. c:macro:: UV_FS_O_RANDOM
+
+ Access is intended to be random. The system can use this as a hint to
+ optimize file caching.
+
+ .. note::
+ `UV_FS_O_RANDOM` is only supported on Windows via
+ `FILE_FLAG_RANDOM_ACCESS <https://msdn.microsoft.com/en-us/library/windows/desktop/aa363858.aspx>`_.
+
+.. c:macro:: UV_FS_O_RDONLY
+
+ Open the file for read-only access.
+
+.. c:macro:: UV_FS_O_RDWR
+
+ Open the file for read-write access.
+
+.. c:macro:: UV_FS_O_SEQUENTIAL
+
+ Access is intended to be sequential from beginning to end. The system can
+ use this as a hint to optimize file caching.
+
+ .. note::
+ `UV_FS_O_SEQUENTIAL` is only supported on Windows via
+ `FILE_FLAG_SEQUENTIAL_SCAN <https://msdn.microsoft.com/en-us/library/windows/desktop/aa363858.aspx>`_.
+
+.. c:macro:: UV_FS_O_SHORT_LIVED
+
+ The file is temporary and should not be flushed to disk if possible.
+
+ .. note::
+ `UV_FS_O_SHORT_LIVED` is only supported on Windows via
+ `FILE_ATTRIBUTE_TEMPORARY <https://msdn.microsoft.com/en-us/library/windows/desktop/aa363858.aspx>`_.
+
+.. c:macro:: UV_FS_O_SYMLINK
+
+ Open the symbolic link itself rather than the resource it points to.
+
+.. c:macro:: UV_FS_O_SYNC
+
+ The file is opened for synchronous I/O. Write operations will complete once
+ all data and all metadata are flushed to disk.
+
+ .. note::
+ `UV_FS_O_SYNC` is supported on Windows via
+ `FILE_FLAG_WRITE_THROUGH <https://msdn.microsoft.com/en-us/library/windows/desktop/cc644950.aspx>`_.
+
+.. c:macro:: UV_FS_O_TEMPORARY
+
+ The file is temporary and should not be flushed to disk if possible.
+
+ .. note::
+ `UV_FS_O_TEMPORARY` is only supported on Windows via
+ `FILE_ATTRIBUTE_TEMPORARY <https://msdn.microsoft.com/en-us/library/windows/desktop/aa363858.aspx>`_.
+
+.. c:macro:: UV_FS_O_TRUNC
+
+ If the file exists and is a regular file, and the file is opened
+ successfully for write access, its length shall be truncated to zero.
+
+.. c:macro:: UV_FS_O_WRONLY
+
+ Open the file for write-only access.
diff --git a/deps/uv/docs/src/loop.rst b/deps/uv/docs/src/loop.rst
index 02543171de..c63f813993 100644
--- a/deps/uv/docs/src/loop.rst
+++ b/deps/uv/docs/src/loop.rst
@@ -86,6 +86,9 @@ API
should) be closed with :c:func:`uv_loop_close` so the resources associated
with it are freed.
+ .. warning::
+ This function is not thread safe.
+
.. c:function:: int uv_run(uv_loop_t* loop, uv_run_mode mode)
This function runs the event loop. It will act differently depending on the
diff --git a/deps/uv/docs/src/misc.rst b/deps/uv/docs/src/misc.rst
index 3fea708a8d..2968d1cea1 100644
--- a/deps/uv/docs/src/misc.rst
+++ b/deps/uv/docs/src/misc.rst
@@ -59,6 +59,12 @@ Data types
Abstract representation of a file descriptor. On Unix systems this is a
`typedef` of `int` and on Windows a `HANDLE`.
+.. c:type:: uv_pid_t
+
+ Cross platform representation of a `pid_t`.
+
+ .. versionadded:: 1.16.0
+
.. c:type:: uv_rusage_t
Data type for resource usage results.
@@ -221,6 +227,12 @@ API
On Windows not all fields are set, the unsupported fields are filled with zeroes.
See :c:type:`uv_rusage_t` for more details.
+.. c:function:: uv_pid_t uv_os_getppid(void)
+
+ Returns the parent process ID.
+
+ .. versionadded:: 1.16.0
+
.. c:function:: int uv_cpu_info(uv_cpu_info_t** cpu_infos, int* count)
Gets information about the CPUs on the system. The `cpu_infos` array will
@@ -271,6 +283,60 @@ API
and :man:`inet_pton(3)`. On success they return 0. In case of error
the target `dst` pointer is unmodified.
+.. c:macro:: UV_IF_NAMESIZE
+
+ Maximum IPv6 interface identifier name length. Defined as
+ `IFNAMSIZ` on Unix and `IF_NAMESIZE` on Linux and Windows.
+
+ .. versionadded:: 1.16.0
+
+.. c:function:: int uv_if_indextoname(unsigned int ifindex, char* buffer, size_t* size)
+
+ IPv6-capable implementation of :man:`if_indextoname(3)`. When called,
+ `*size` indicates the length of the `buffer`, which is used to store the
+ result.
+ On success, zero is returned, `buffer` contains the interface name, and
+ `*size` represents the string length of the `buffer`, excluding the NUL
+ terminator byte from `*size`. On error, a negative result is
+ returned. If `buffer` is not large enough to hold the result,
+ `UV_ENOBUFS` is returned, and `*size` represents the necessary size in
+ bytes, including the NUL terminator byte into the `*size`.
+
+ On Unix, the returned interface name can be used directly as an
+ interface identifier in scoped IPv6 addresses, e.g.
+ `fe80::abc:def1:2345%en0`.
+
+ On Windows, the returned interface cannot be used as an interface
+ identifier, as Windows uses numerical interface identifiers, e.g.
+ `fe80::abc:def1:2345%5`.
+
+ To get an interface identifier in a cross-platform compatible way,
+ use `uv_if_indextoiid()`.
+
+ Example:
+
+ ::
+
+ char ifname[UV_IF_NAMESIZE];
+ size_t size = sizeof(ifname);
+ uv_if_indextoname(sin6->sin6_scope_id, ifname, &size);
+
+ .. versionadded:: 1.16.0
+
+.. c:function:: int uv_if_indextoiid(unsigned int ifindex, char* buffer, size_t* size)
+
+ Retrieves a network interface identifier suitable for use in an IPv6 scoped
+ address. On Windows, returns the numeric `ifindex` as a string. On all other
+ platforms, `uv_if_indextoname()` is called. The result is written to
+ `buffer`, with `*size` indicating the length of `buffer`. If `buffer` is not
+ large enough to hold the result, then `UV_ENOBUFS` is returned, and `*size`
+ represents the size, including the NUL byte, required to hold the
+ result.
+
+ See `uv_if_indextoname` for further details.
+
+ .. versionadded:: 1.16.0
+
.. c:function:: int uv_exepath(char* buffer, size_t* size)
Gets the executable path.
diff --git a/deps/uv/docs/src/pipe.rst b/deps/uv/docs/src/pipe.rst
index d33b0f2b97..bdaeeba9d4 100644
--- a/deps/uv/docs/src/pipe.rst
+++ b/deps/uv/docs/src/pipe.rst
@@ -102,3 +102,12 @@ API
and call ``uv_accept(pipe, handle)``.
.. seealso:: The :c:type:`uv_stream_t` API functions also apply.
+
+.. c:function:: int uv_pipe_chmod(uv_pipe_t* handle, int flags)
+
+ Alters pipe permissions, allowing it to be accessed from processes run by
+ different users. Makes the pipe writable or readable by all users. Mode can
+ be ``UV_WRITABLE``, ``UV_READABLE`` or ``UV_WRITABLE | UV_READABLE``. This
+ function is blocking.
+
+ .. versionadded:: 1.16.0