diff options
| author | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-01-20 09:00:12 +0100 |
|---|---|---|
| committer | Saúl Ibarra Corretgé <saghul@gmail.com> | 2015-01-21 09:12:25 +0100 |
| commit | 737cd1fb4f79295bba665f2d965718b006f87ac1 (patch) | |
| tree | 1ba67f58b7d3c8c5c973d36d0a3dd1d6516f69c2 /docs/src | |
| parent | ea5f1f98e0043d6f8deb9edeb0525a19adcf3429 (diff) | |
| download | libuv-737cd1fb4f79295bba665f2d965718b006f87ac1.tar.gz libuv-737cd1fb4f79295bba665f2d965718b006f87ac1.zip | |
doc: clarify uv_default_loop
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>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/loop.rst | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/src/loop.rst b/docs/src/loop.rst index d347534b..203672bd 100644 --- a/docs/src/loop.rst +++ b/docs/src/loop.rst @@ -80,6 +80,12 @@ API Returns the initialized default loop. It may return NULL in case of 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) This function runs the event loop. It will act differently depending on the |