diff options
Diffstat (limited to 'deps/uv/docs/src')
| -rw-r--r-- | deps/uv/docs/src/handle.rst | 3 | ||||
| -rw-r--r-- | deps/uv/docs/src/loop.rst | 2 | ||||
| -rw-r--r-- | deps/uv/docs/src/threading.rst | 11 | ||||
| -rw-r--r-- | deps/uv/docs/src/timer.rst | 2 |
4 files changed, 15 insertions, 3 deletions
diff --git a/deps/uv/docs/src/handle.rst b/deps/uv/docs/src/handle.rst index e4cb90b5f7..cdfb76bf8c 100644 --- a/deps/uv/docs/src/handle.rst +++ b/deps/uv/docs/src/handle.rst @@ -9,6 +9,9 @@ Structures are aligned so that any libuv handle can be cast to `uv_handle_t`. All API functions defined here work with any handle type. +Libuv handles are not movable. Pointers to handle structures passed to +functions must remain valid for the duration of the requested operation. Take +care when using stack allocated handles. Data types ---------- diff --git a/deps/uv/docs/src/loop.rst b/deps/uv/docs/src/loop.rst index dcde5049ac..86a99adf5d 100644 --- a/deps/uv/docs/src/loop.rst +++ b/deps/uv/docs/src/loop.rst @@ -219,7 +219,7 @@ API .. caution:: - Any previous value returned from :c:func`uv_backend_fd` is now + Any previous value returned from :c:func:`uv_backend_fd` is now invalid. That function must be called again to determine the correct backend file descriptor. diff --git a/deps/uv/docs/src/threading.rst b/deps/uv/docs/src/threading.rst index bca8ba1d06..89bb4a6f3a 100644 --- a/deps/uv/docs/src/threading.rst +++ b/deps/uv/docs/src/threading.rst @@ -131,8 +131,15 @@ Functions return 0 on success or an error code < 0 (unless the return type is void, of course). .. note:: - Callers should be prepared to deal with spurious wakeups on :c:func:`uv_cond_wait` and - :c:func:`uv_cond_timedwait`. + 1. Callers should be prepared to deal with spurious wakeups on :c:func:`uv_cond_wait` + and :c:func:`uv_cond_timedwait`. + 2. The timeout parameter for :c:func:`uv_cond_timedwait` is relative to the time + at which function is called. + 3. On z/OS, the timeout parameter for :c:func:`uv_cond_timedwait` is converted to an + absolute system time at which the wait expires. If the current system clock time + passes the absolute time calculated before the condition is signaled, an ETIMEDOUT + error results. After the wait begins, the wait time is not affected by changes + to the system clock. .. c:function:: int uv_cond_init(uv_cond_t* cond) .. c:function:: void uv_cond_destroy(uv_cond_t* cond) diff --git a/deps/uv/docs/src/timer.rst b/deps/uv/docs/src/timer.rst index 8e11f257f8..e163e288fd 100644 --- a/deps/uv/docs/src/timer.rst +++ b/deps/uv/docs/src/timer.rst @@ -45,6 +45,8 @@ API .. note:: Does not update the event loop's concept of "now". See :c:func:`uv_update_time` for more information. + If the timer is already active, it is simply updated. + .. c:function:: int uv_timer_stop(uv_timer_t* handle) Stop the timer, the callback will not be called anymore. |