aboutsummaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorBen Noordhuis <info@bnoordhuis.nl>2020-06-08 09:03:29 +0200
committerJameson Nash <vtjnash@gmail.com>2020-11-05 16:41:44 -0500
commit06b731742208c0c7b0b56948da2f2e0c9e645ec9 (patch)
treeb26072c77b26f27e71910572651141df9de32f15 /docs/src
parent04b05605d39d69c11b605793eebbde10195b4a23 (diff)
downloadlibuv-06b731742208c0c7b0b56948da2f2e0c9e645ec9.tar.gz
libuv-06b731742208c0c7b0b56948da2f2e0c9e645ec9.zip
unix,win: harmonize uv_read_start() error handling
The behavior of `uv_read_start()` when the handle is closing or already busy reading wasn't consistent across platforms. Now it is. Fixes: https://github.com/libuv/help/issues/137 PR-URL: https://github.com/libuv/libuv/pull/2795 Reviewed-By: Jameson Nash <vtjnash@gmail.com> Reviewed-By: Santiago Gimeno <santiago.gimeno@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com>
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/stream.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/src/stream.rst b/docs/src/stream.rst
index 2ccb59b5..429ebdab 100644
--- a/docs/src/stream.rst
+++ b/docs/src/stream.rst
@@ -139,6 +139,11 @@ API
be made several times until there is no more data to read or
:c:func:`uv_read_stop` is called.
+ .. versionchanged:: 1.38.0 :c:func:`uv_read_start()` now consistently
+ returns `UV_EALREADY` when called twice, and `UV_EINVAL` when the
+ stream is closing. With older libuv versions, it returns `UV_EALREADY`
+ on Windows but not UNIX, and `UV_EINVAL` on UNIX but not Windows.
+
.. c:function:: int uv_read_stop(uv_stream_t*)
Stop reading data from the stream. The :c:type:`uv_read_cb` callback will