Skip to content

Commit

Permalink
doc: clarify uv_loop_close()
Browse files Browse the repository at this point in the history
Make explicit that handles and requests should be closed before calling
uv_loop_close().

Fixes: libuv#765
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
  • Loading branch information
bnoordhuis committed Mar 20, 2016
1 parent f04d5fc commit df96163
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/src/loop.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,10 @@ API

.. c:function:: int uv_loop_close(uv_loop_t* loop)
Closes all internal loop resources. This function must only be called once
the loop has finished its execution or it will return UV_EBUSY. After this
function returns the user shall free the memory allocated for the loop.
Releases all internal loop resources. Call this function only when the loop
has finished executing and all open handles and requests have been closed,
or it will return UV_EBUSY. After this function returns, the user can free
the memory allocated for the loop.
.. c:function:: uv_loop_t* uv_default_loop(void)
Expand Down

0 comments on commit df96163

Please sign in to comment.