diff options
author | Vit Gottwald <vit.gottwald@gmail.com> | 2016-09-17 16:40:44 +0200 |
---|---|---|
committer | Saúl Ibarra Corretgé <saghul@gmail.com> | 2016-09-22 01:50:09 +0200 |
commit | 20c9c0105be0682843641e671410abaeecd1efff (patch) | |
tree | 0ef6f68f545bbfc90a66aeaf7865b7d724b465e7 /docs/src | |
parent | 468d44620a13447e3521ca7a6ad544100e6a0c5e (diff) | |
download | libuv-20c9c0105be0682843641e671410abaeecd1efff.tar.gz libuv-20c9c0105be0682843641e671410abaeecd1efff.zip |
doc: add description of uv_handle_type
Fixes: https://github.com/libuv/libuv/issues/1044
PR-URL: https://github.com/libuv/libuv/pull/1059
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Diffstat (limited to 'docs/src')
-rw-r--r-- | docs/src/handle.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/src/handle.rst b/docs/src/handle.rst index b0a123cf..14aec51f 100644 --- a/docs/src/handle.rst +++ b/docs/src/handle.rst @@ -17,6 +17,34 @@ Data types The base libuv handle type. +.. c:type:: uv_handle_type + + The kind of the libuv handle. + + :: + + typedef enum { + UV_UNKNOWN_HANDLE = 0, + UV_ASYNC, + UV_CHECK, + UV_FS_EVENT, + UV_FS_POLL, + UV_HANDLE, + UV_IDLE, + UV_NAMED_PIPE, + UV_POLL, + UV_PREPARE, + UV_PROCESS, + UV_STREAM, + UV_TCP, + UV_TIMER, + UV_TTY, + UV_UDP, + UV_SIGNAL, + UV_FILE, + UV_HANDLE_TYPE_MAX + } uv_handle_type; + .. c:type:: uv_any_handle Union of all handle types. @@ -58,6 +86,10 @@ Public members Pointer to the :c:type:`uv_loop_t` where the handle is running on. Readonly. +.. c:member:: uv_loop_t* uv_handle_t.type + + Pointer to the :c:type:`uv_handle_type`. Readonly. + .. c:member:: void* uv_handle_t.data Space for user-defined arbitrary data. libuv does not use this field. |