diff options
Diffstat (limited to 'deps/uv/docs')
-rw-r--r-- | deps/uv/docs/src/dll.rst | 2 | ||||
-rw-r--r-- | deps/uv/docs/src/request.rst | 2 | ||||
-rw-r--r-- | deps/uv/docs/src/stream.rst | 24 | ||||
-rw-r--r-- | deps/uv/docs/src/timer.rst | 10 |
4 files changed, 22 insertions, 16 deletions
diff --git a/deps/uv/docs/src/dll.rst b/deps/uv/docs/src/dll.rst index 3fb11e192d..fb13f90815 100644 --- a/deps/uv/docs/src/dll.rst +++ b/deps/uv/docs/src/dll.rst @@ -34,7 +34,7 @@ API Close the shared library. -.. c:function:: uv_dlsym(uv_lib_t* lib, const char* name, void** ptr) +.. c:function:: int uv_dlsym(uv_lib_t* lib, const char* name, void** ptr) Retrieves a data pointer from a dynamic library. It is legal for a symbol to map to NULL. Returns 0 on success and -1 if the symbol was not found. diff --git a/deps/uv/docs/src/request.rst b/deps/uv/docs/src/request.rst index 2f58d46b14..660b80ae95 100644 --- a/deps/uv/docs/src/request.rst +++ b/deps/uv/docs/src/request.rst @@ -25,7 +25,7 @@ Data types Public members ^^^^^^^^^^^^^^ -.. c:member:: void* uv_request_t.data +.. c:member:: void* uv_req_t.data Space for user-defined arbitrary data. libuv does not use this field. diff --git a/deps/uv/docs/src/stream.rst b/deps/uv/docs/src/stream.rst index 21562b3702..9f0aacd164 100644 --- a/deps/uv/docs/src/stream.rst +++ b/deps/uv/docs/src/stream.rst @@ -32,8 +32,14 @@ Data types Callback called when data was read on a stream. - `nread` is > 0 if there is data available, 0 if libuv is done reading for - now, or < 0 on error. + `nread` is > 0 if there is data available or < 0 on error. When we've + reached EOF, `nread` will be set to ``UV_EOF``. When `nread` < 0, + the `buf` parameter might not point to a valid buffer; in that case + `buf.len` and `buf.base` are both set to 0. + + .. note:: + `nread` might be 0, which does *not* indicate an error or EOF. This + is equivalent to ``EAGAIN`` or ``EWOULDBLOCK`` under ``read(2)``. The callee is responsible for stopping closing the stream when an error happens by calling :c:func:`uv_read_stop` or :c:func:`uv_close`. Trying to read @@ -125,17 +131,9 @@ API .. c:function:: int uv_read_start(uv_stream_t* stream, uv_alloc_cb alloc_cb, uv_read_cb read_cb) - Read data from an incoming stream. The callback will be made several - times until there is no more data to read or :c:func:`uv_read_stop` is called. - When we've reached EOF `nread` will be set to ``UV_EOF``. - - When `nread` < 0, the `buf` parameter might not point to a valid buffer; - in that case `buf.len` and `buf.base` are both set to 0. - - .. note:: - `nread` might also be 0, which does *not* indicate an error or EOF, it happens when - libuv requested a buffer through the alloc callback but then decided that it didn't - need that buffer. + Read data from an incoming stream. The :c:type:`uv_read_cb` callback will + be made several times until there is no more data to read or + :c:func:`uv_read_stop` is called. .. c:function:: int uv_read_stop(uv_stream_t*) diff --git a/deps/uv/docs/src/timer.rst b/deps/uv/docs/src/timer.rst index e558704cb2..31d733efc3 100644 --- a/deps/uv/docs/src/timer.rst +++ b/deps/uv/docs/src/timer.rst @@ -54,7 +54,15 @@ API .. c:function:: void uv_timer_set_repeat(uv_timer_t* handle, uint64_t repeat) - Set the repeat value in milliseconds. + Set the repeat interval value in milliseconds. The timer will be scheduled + to run on the given interval, regardless of the callback execution + duration, and will follow normal timer semantics in the case of a + time-slice overrun. + + For example, if a 50ms repeating timer first runs for 17ms, it will be + scheduled to run again 33ms later. If other tasks consume more than the + 33ms following the first timer callback, then the callback will run as soon + as possible. .. note:: If the repeat value is set from a timer callback it does not immediately take effect. |