gre-ilya/libuv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: clarify uv_default_loop

Browse Source 
Indicate that it can (and should) also be closed, currently it's not
"special" in any way.

PR-URL: https://github.com/libuv/libuv/pull/147
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
This commit is contained in:
Saúl Ibarra Corretgé 2015-01-20 09:00:12 +01:00
parent ea5f1f98e0
commit 737cd1fb4f
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/loop.rst
View File

@ -80,6 +80,12 @@ API
Returns the initialized default loop. It may return NULL in case of Returns the initialized default loop. It may return NULL in case of
allocation failure. allocation failure.
This function is just a convenient way for having a global loop throughout
an application, the default loop is in no way different than the ones
initialized with :c:func:`uv_loop_init`. As such, the default loop can (and
should) be closed with :c:func:`uv_loop_close` so the resources associated
with it are freed.
.. c:function:: int uv_run(uv_loop_t* loop, uv_run_mode mode) .. c:function:: int uv_run(uv_loop_t* loop, uv_run_mode mode)
This function runs the event loop. It will act differently depending on the This function runs the event loop. It will act differently depending on the