From 9486e462fce7754c72933118166602c938e344a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sa=C3=BAl=20Ibarra=20Corretg=C3=A9?= Date: Tue, 30 Sep 2014 09:09:59 +0200 Subject: [PATCH] doc: document missing stream related structures uv_connect_t, uv_write_t and uv_shutdown_t. Closes #1507 --- docs/src/stream.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/src/stream.rst b/docs/src/stream.rst index 686efa1b3..44dccbe94 100644 --- a/docs/src/stream.rst +++ b/docs/src/stream.rst @@ -16,6 +16,18 @@ Data types Stream handle type. +.. c:type:: uv_connect_t + + Connect request type. + +.. c:type:: uv_shutdown_t + + Shutdown request type. + +.. c:type:: uv_write_t + + Write request type. + .. c:type:: void (*uv_read_cb)(uv_stream_t* stream, ssize_t nread, const uv_buf_t* buf) Callback called when data was read on a stream. @@ -60,6 +72,22 @@ Public members Contains the amount of queued bytes waiting to be sent. Readonly. +.. c:member:: uv_stream_t* uv_connect_t.handle + + Pointer to the stream where this connection request is running. + +.. c:member:: uv_stream_t* uv_shutdown_t.handle + + Pointer to the stream where this shutdown request is running. + +.. c:member:: uv_stream_t* uv_write_t.handle + + Pointer to the stream where this write request is running. + +.. c:member:: uv_stream_t* uv_write_t.send_handle + + Pointer to the stream being sent using this write request.. + .. seealso:: The :c:type:`uv_handle_t` members also apply.