diff options
| author | Corbin Simpson <MostAwesomeDude@gmail.com> | 2015-08-09 13:21:17 -0700 |
|---|---|---|
| committer | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-08-10 09:20:51 +0200 |
| commit | fc556acbb48c5bbedc928f1e8e2af89bc5681334 (patch) | |
| tree | 5d15d0f26959bbb1a73a3418ad3612a99a8f296b /docs/src | |
| parent | 01544d861b9e11f844d482a80bc557dd9b803c8c (diff) | |
| download | libuv-fc556acbb48c5bbedc928f1e8e2af89bc5681334.tar.gz libuv-fc556acbb48c5bbedc928f1e8e2af89bc5681334.zip | |
doc: clarify uv_read_stop() is idempotent
PR-URL: https://github.com/libuv/libuv/pull/478
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/stream.rst | 2 |
1 files changed, 2 insertions, 0 deletions
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: |