summaryrefslogtreecommitdiff
path: root/deps/uv/docs
diff options
context:
space:
mode:
authorcjihrig <cjihrig@gmail.com>2019-09-09 13:08:37 -0400
committerRich Trott <rtrott@gmail.com>2019-09-12 00:49:02 -0700
commitdf0e2e3625d1f72e8b04e05ffa13997a51e9f0d7 (patch)
tree5ef978de762b47bcfc6323c48e7e22b862d6d657 /deps/uv/docs
parent62e8cc5e61a36ebe1bd913983a452961aa1c9946 (diff)
downloadandroid-node-v8-df0e2e3625d1f72e8b04e05ffa13997a51e9f0d7.tar.gz
android-node-v8-df0e2e3625d1f72e8b04e05ffa13997a51e9f0d7.tar.bz2
android-node-v8-df0e2e3625d1f72e8b04e05ffa13997a51e9f0d7.zip
deps: upgrade to libuv 1.32.0
Notable changes: - `uv_tcp_close_reset()` has been added. - `uv_udp_set_source_membership()` has been added. - A double free in `uv_free_cpu_info()` on OpenBSD has been fixed. - Defined, but empty environment variables can now be read on Windows. - Several improvements to the cmake build process. - The `EILSEQ` error code is now mapped by libuv. PR-URL: https://github.com/nodejs/node/pull/29508 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'deps/uv/docs')
-rw-r--r--deps/uv/docs/src/handle.rst5
-rw-r--r--deps/uv/docs/src/signal.rst11
-rw-r--r--deps/uv/docs/src/stream.rst4
-rw-r--r--deps/uv/docs/src/tcp.rst10
-rw-r--r--deps/uv/docs/src/udp.rst30
5 files changed, 53 insertions, 7 deletions
diff --git a/deps/uv/docs/src/handle.rst b/deps/uv/docs/src/handle.rst
index 544794db06..0a25bfa8b2 100644
--- a/deps/uv/docs/src/handle.rst
+++ b/deps/uv/docs/src/handle.rst
@@ -60,6 +60,9 @@ Data types
a ``UV_ENOBUFS`` error will be triggered in the :c:type:`uv_udp_recv_cb` or the
:c:type:`uv_read_cb` callback.
+ Each buffer is used only once and the user is responsible for freeing it in the
+ :c:type:`uv_udp_recv_cb` or the :c:type:`uv_read_cb` callback.
+
A suggested size (65536 at the moment in most cases) is provided, but it's just an indication,
not related in any way to the pending data to be read. The user is free to allocate the amount
of memory they decide.
@@ -87,7 +90,7 @@ Public members
.. c:member:: uv_loop_t* uv_handle_t.loop
- Pointer to the :c:type:`uv_loop_t` where the handle is running on. Readonly.
+ Pointer to the :c:type:`uv_loop_t` the handle is running on. Readonly.
.. c:member:: uv_handle_type uv_handle_t.type
diff --git a/deps/uv/docs/src/signal.rst b/deps/uv/docs/src/signal.rst
index f5a809ab0b..eeadb95b0a 100644
--- a/deps/uv/docs/src/signal.rst
+++ b/deps/uv/docs/src/signal.rst
@@ -20,6 +20,15 @@ Reception of some signals is emulated:
program is given approximately 10 seconds to perform cleanup. After that
Windows will unconditionally terminate it.
+* SIGWINCH is raised whenever libuv detects that the console has been
+ resized. When a libuv app is running under a console emulator, or when a
+ 32-bit libuv app is running on 64-bit system, SIGWINCH will be emulated. In
+ such cases SIGWINCH signals may not always be delivered in a timely manner.
+ For a writable :c:type:`uv_tty_t` handle libuv will only detect size changes
+ when the cursor is moved. When a readable :c:type:`uv_tty_t` handle is used,
+ resizing of the console buffer will be detected only if the handle is in raw
+ mode and is being read.
+
* Watchers for other signals can be successfully created, but these signals
are never received. These signals are: `SIGILL`, `SIGABRT`, `SIGFPE`, `SIGSEGV`,
`SIGTERM` and `SIGKILL.`
@@ -28,6 +37,8 @@ Reception of some signals is emulated:
not detected by libuv; these will not trigger a signal watcher.
.. versionchanged:: 1.15.0 SIGWINCH support on Windows was improved.
+.. versionchanged:: 1.31.0 32-bit libuv SIGWINCH support on 64-bit Windows was
+ rolled back to old implementation.
Unix notes
----------
diff --git a/deps/uv/docs/src/stream.rst b/deps/uv/docs/src/stream.rst
index 6a704367b1..2ccb59b51c 100644
--- a/deps/uv/docs/src/stream.rst
+++ b/deps/uv/docs/src/stream.rst
@@ -50,8 +50,8 @@ Data types
from the stream again is undefined.
The callee is responsible for freeing the buffer, libuv does not reuse it.
- The buffer may be a null buffer (where buf->base=NULL and buf->len=0) on
- error.
+ The buffer may be a null buffer (where `buf->base` == NULL and `buf->len` == 0)
+ on error.
.. c:type:: void (*uv_write_cb)(uv_write_t* req, int status)
diff --git a/deps/uv/docs/src/tcp.rst b/deps/uv/docs/src/tcp.rst
index d20a6362af..bcb163ea0f 100644
--- a/deps/uv/docs/src/tcp.rst
+++ b/deps/uv/docs/src/tcp.rst
@@ -113,3 +113,13 @@ API
mapping
.. seealso:: The :c:type:`uv_stream_t` API functions also apply.
+
+.. c:function:: int uv_tcp_close_reset(uv_tcp_t* handle, uv_close_cb close_cb)
+
+ Resets a TCP connection by sending a RST packet. This is accomplished by
+ setting the `SO_LINGER` socket option with a linger interval of zero and
+ then calling :c:func:`uv_close`.
+ Due to some platform inconsistencies, mixing of :c:func:`uv_shutdown` and
+ :c:func:`uv_tcp_close_reset` calls is not allowed.
+
+ .. versionadded:: 1.32.0
diff --git a/deps/uv/docs/src/udp.rst b/deps/uv/docs/src/udp.rst
index f3de53fbab..53b1fea493 100644
--- a/deps/uv/docs/src/udp.rst
+++ b/deps/uv/docs/src/udp.rst
@@ -56,16 +56,19 @@ Data types
* `handle`: UDP handle
* `nread`: Number of bytes that have been received.
- 0 if there is no more data to read. You may discard or repurpose
- the read buffer. Note that 0 may also mean that an empty datagram
- was received (in this case `addr` is not NULL). < 0 if a transmission
- error was detected.
+ 0 if there is no more data to read. Note that 0 may also mean that an
+ empty datagram was received (in this case `addr` is not NULL). < 0 if
+ a transmission error was detected.
* `buf`: :c:type:`uv_buf_t` with the received data.
* `addr`: ``struct sockaddr*`` containing the address of the sender.
Can be NULL. Valid for the duration of the callback only.
* `flags`: One or more or'ed UV_UDP_* constants. Right now only
``UV_UDP_PARTIAL`` is used.
+ The callee is responsible for freeing the buffer, libuv does not reuse it.
+ The buffer may be a null buffer (where `buf->base` == NULL and `buf->len` == 0)
+ on error.
+
.. note::
The receive callback will be called with `nread` == 0 and `addr` == NULL when there is
nothing to read, and with `nread` == 0 and `addr` != NULL when an empty UDP packet is
@@ -219,6 +222,25 @@ API
:returns: 0 on success, or an error code < 0 on failure.
+.. c:function:: int uv_udp_set_source_membership(uv_udp_t* handle, const char* multicast_addr, const char* interface_addr, const char* source_addr, uv_membership membership)
+
+ Set membership for a source-specific multicast group.
+
+ :param handle: UDP handle. Should have been initialized with
+ :c:func:`uv_udp_init`.
+
+ :param multicast_addr: Multicast address to set membership for.
+
+ :param interface_addr: Interface address.
+
+ :param source_addr: Source address.
+
+ :param membership: Should be ``UV_JOIN_GROUP`` or ``UV_LEAVE_GROUP``.
+
+ :returns: 0 on success, or an error code < 0 on failure.
+
+ .. versionadded:: 1.32.0
+
.. c:function:: int uv_udp_set_multicast_loop(uv_udp_t* handle, int on)
Set IP multicast loop flag. Makes multicast packets loop back to