summaryrefslogtreecommitdiff
path: root/deps/uv/docs/src
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2017-09-06 09:59:10 -0400
committercjihrig <cjihrig@gmail.com>2017-09-06 10:16:35 -0400
commit8485a7c0b71fd1dd36947a6dd02b75387805d9b7 (patch)
tree01394e3fce1af43e0153a9c5ef911ff127bad5eb /deps/uv/docs/src
parent1403d28e7ded280e7582daa6e999164588d2234e (diff)
downloadandroid-node-v8-8485a7c0b71fd1dd36947a6dd02b75387805d9b7.tar.gz
android-node-v8-8485a7c0b71fd1dd36947a6dd02b75387805d9b7.tar.bz2
android-node-v8-8485a7c0b71fd1dd36947a6dd02b75387805d9b7.zip
deps: upgrade libuv to 1.14.1
Fixes: https://github.com/nodejs/node/issues/12737 Fixes: https://github.com/nodejs/node/issues/13581 Fixes: https://github.com/nodejs/node/issues/15117 PR-URL: https://github.com/nodejs/node/pull/14866 Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'deps/uv/docs/src')
-rw-r--r--deps/uv/docs/src/async.rst6
-rw-r--r--deps/uv/docs/src/fs.rst19
-rw-r--r--deps/uv/docs/src/misc.rst23
-rw-r--r--deps/uv/docs/src/poll.rst15
-rw-r--r--deps/uv/docs/src/stream.rst2
5 files changed, 49 insertions, 16 deletions
diff --git a/deps/uv/docs/src/async.rst b/deps/uv/docs/src/async.rst
index 5c40045824..02e6a58e78 100644
--- a/deps/uv/docs/src/async.rst
+++ b/deps/uv/docs/src/async.rst
@@ -35,12 +35,16 @@ API
Initialize the handle. A NULL callback is allowed.
+ :returns: 0 on success, or an error code < 0 on failure.
+
.. note::
Unlike other handle initialization functions, it immediately starts the handle.
.. c:function:: int uv_async_send(uv_async_t* async)
- Wakeup the event loop and call the async handle's callback.
+ Wake up the event loop and call the async handle's callback.
+
+ :returns: 0 on success, or an error code < 0 on failure.
.. note::
It's safe to call this function from any thread. The callback will be called on the
diff --git a/deps/uv/docs/src/fs.rst b/deps/uv/docs/src/fs.rst
index 3f766e393f..2db915bc9e 100644
--- a/deps/uv/docs/src/fs.rst
+++ b/deps/uv/docs/src/fs.rst
@@ -92,7 +92,8 @@ Data types
UV_FS_READLINK,
UV_FS_CHOWN,
UV_FS_FCHOWN,
- UV_FS_REALPATH
+ UV_FS_REALPATH,
+ UV_FS_COPYFILE
} uv_fs_type;
.. c:type:: uv_dirent_t
@@ -241,6 +242,22 @@ API
Equivalent to :man:`ftruncate(2)`.
+.. c:function:: int uv_fs_copyfile(uv_loop_t* loop, uv_fs_t* req, const char* path, const char* new_path, int flags, uv_fs_cb cb)
+
+ Copies a file from `path` to `new_path`. Supported `flags` are described below.
+
+ - `UV_FS_COPYFILE_EXCL`: If present, `uv_fs_copyfile()` will fail with
+ `UV_EEXIST` if the destination path already exists. The default behavior
+ is to overwrite the destination if it exists.
+
+ .. warning::
+ If the destination path is created, but an error occurs while copying
+ the data, then the destination path is removed. There is a brief window
+ of time between closing and removing the file where another process
+ could access the file.
+
+ .. versionadded:: 1.14.0
+
.. c:function:: int uv_fs_sendfile(uv_loop_t* loop, uv_fs_t* req, uv_file out_fd, uv_file in_fd, int64_t in_offset, size_t length, uv_fs_cb cb)
Limited equivalent to :man:`sendfile(2)`.
diff --git a/deps/uv/docs/src/misc.rst b/deps/uv/docs/src/misc.rst
index 9d7c3617e8..3fea708a8d 100644
--- a/deps/uv/docs/src/misc.rst
+++ b/deps/uv/docs/src/misc.rst
@@ -186,17 +186,24 @@ API
.. c:function:: int uv_get_process_title(char* buffer, size_t size)
- Gets the title of the current process. If `buffer` is `NULL` or `size` is
- zero, `UV_EINVAL` is returned. If `size` cannot accommodate the process
- title and terminating `NULL` character, the function returns `UV_ENOBUFS`.
+ Gets the title of the current process. You *must* call `uv_setup_args`
+ before calling this function. If `buffer` is `NULL` or `size` is zero,
+ `UV_EINVAL` is returned. If `size` cannot accommodate the process title and
+ terminating `NULL` character, the function returns `UV_ENOBUFS`.
+
+ .. warning::
+ `uv_get_process_title` is not thread safe on any platform except Windows.
.. c:function:: int uv_set_process_title(const char* title)
- Sets the current process title. On platforms with a fixed size buffer for the
- process title the contents of `title` will be copied to the buffer and
- truncated if larger than the available space. Other platforms will return
- `UV_ENOMEM` if they cannot allocate enough space to duplicate the contents of
- `title`.
+ Sets the current process title. You *must* call `uv_setup_args` before
+ calling this function. On platforms with a fixed size buffer for the process
+ title the contents of `title` will be copied to the buffer and truncated if
+ larger than the available space. Other platforms will return `UV_ENOMEM` if
+ they cannot allocate enough space to duplicate the contents of `title`.
+
+ .. warning::
+ `uv_set_process_title` is not thread safe on any platform except Windows.
.. c:function:: int uv_resident_set_memory(size_t* rss)
diff --git a/deps/uv/docs/src/poll.rst b/deps/uv/docs/src/poll.rst
index 004ff4b92e..aba8915886 100644
--- a/deps/uv/docs/src/poll.rst
+++ b/deps/uv/docs/src/poll.rst
@@ -54,7 +54,8 @@ Data types
enum uv_poll_event {
UV_READABLE = 1,
UV_WRITABLE = 2,
- UV_DISCONNECT = 4
+ UV_DISCONNECT = 4,
+ UV_PRIORITIZED = 8
};
@@ -84,10 +85,13 @@ API
.. c:function:: int uv_poll_start(uv_poll_t* handle, int events, uv_poll_cb cb)
- Starts polling the file descriptor. `events` is a bitmask consisting made up
- of UV_READABLE, UV_WRITABLE and UV_DISCONNECT. As soon as an event is detected
- the callback will be called with `status` set to 0, and the detected events set on the
- `events` field.
+ Starts polling the file descriptor. `events` is a bitmask made up of
+ UV_READABLE, UV_WRITABLE, UV_PRIORITIZED and UV_DISCONNECT. As soon as an
+ event is detected the callback will be called with `status` set to 0, and the
+ detected events set on the `events` field.
+
+ The UV_PRIORITIZED event is used to watch for sysfs interrupts or TCP out-of-band
+ messages.
The UV_DISCONNECT event is optional in the sense that it may not be
reported and the user is free to ignore it, but it can help optimize the shutdown
@@ -108,6 +112,7 @@ API
on the `events` field in the callback.
.. versionchanged:: 1.9.0 Added the UV_DISCONNECT event.
+ .. versionchanged:: 1.14.0 Added the UV_PRIORITIZED event.
.. c:function:: int uv_poll_stop(uv_poll_t* poll)
diff --git a/deps/uv/docs/src/stream.rst b/deps/uv/docs/src/stream.rst
index de492b3578..1f4e87e63a 100644
--- a/deps/uv/docs/src/stream.rst
+++ b/deps/uv/docs/src/stream.rst
@@ -6,7 +6,7 @@
Stream handles provide an abstraction of a duplex communication channel.
:c:type:`uv_stream_t` is an abstract type, libuv provides 3 stream implementations
-in the for of :c:type:`uv_tcp_t`, :c:type:`uv_pipe_t` and :c:type:`uv_tty_t`.
+in the form of :c:type:`uv_tcp_t`, :c:type:`uv_pipe_t` and :c:type:`uv_tty_t`.
Data types