Skip to content

Commit

Permalink
doc: document uv_async_(init|send) return values
Browse files Browse the repository at this point in the history
Fixes: libuv#576
PR-URL: libuv#1435
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
  • Loading branch information
bnoordhuis committed Jul 27, 2017
1 parent cbcf13a commit 19e51ae
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/src/async.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,16 @@ API
Initialize the handle. A NULL callback is allowed.
:returns: 0 on success, or an error code < 0 on failure.
.. note::
Unlike other handle initialization functions, it immediately starts the handle.
.. c:function:: int uv_async_send(uv_async_t* async)
Wakeup the event loop and call the async handle's callback.
Wake up the event loop and call the async handle's callback.
:returns: 0 on success, or an error code < 0 on failure.
.. note::
It's safe to call this function from any thread. The callback will be called on the
Expand Down

0 comments on commit 19e51ae

Please sign in to comment.