From fc556acbb48c5bbedc928f1e8e2af89bc5681334 Mon Sep 17 00:00:00 2001 From: Corbin Simpson Date: Sun, 9 Aug 2015 13:21:17 -0700 Subject: [PATCH] doc: clarify uv_read_stop() is idempotent MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/libuv/libuv/pull/478 Reviewed-By: Saúl Ibarra Corretgé --- docs/src/stream.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/src/stream.rst b/docs/src/stream.rst index 59d58466..21562b37 100644 --- a/docs/src/stream.rst +++ b/docs/src/stream.rst @@ -142,6 +142,8 @@ API Stop reading data from the stream. The :c:type:`uv_read_cb` callback will no longer be called. + This function is idempotent and may be safely called on a stopped stream. + .. c:function:: int uv_write(uv_write_t* req, uv_stream_t* handle, const uv_buf_t bufs[], unsigned int nbufs, uv_write_cb cb) Write data to stream. Buffers are written in order. Example: