diff options
| author | Ben Noordhuis <info@bnoordhuis.nl> | 2016-03-16 10:15:27 +0100 |
|---|---|---|
| committer | Ben Noordhuis <info@bnoordhuis.nl> | 2016-03-20 10:15:20 +0100 |
| commit | df961637027df4093aaad5faab16a617ab13b335 (patch) | |
| tree | 40e0b44242c20b5b5e6882f7f525c16ecce12502 /docs/src | |
| parent | f04d5fc3b98cfa6699b9d0b2dedda84a14689761 (diff) | |
| download | libuv-df961637027df4093aaad5faab16a617ab13b335.tar.gz libuv-df961637027df4093aaad5faab16a617ab13b335.zip | |
doc: clarify uv_loop_close()
Make explicit that handles and requests should be closed before calling
uv_loop_close().
Fixes: https://github.com/libuv/libuv/issues/765
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/loop.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/src/loop.rst b/docs/src/loop.rst index 2a01d796..1f504cb3 100644 --- a/docs/src/loop.rst +++ b/docs/src/loop.rst @@ -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) |