From 7ef23d9e85b42abd83594575ba95c8499e993980 Mon Sep 17 00:00:00 2001 From: Ed Schouten Date: Wed, 11 Oct 2017 10:28:52 +0200 Subject: [PATCH] doc: clarify the description of uv_loop_alive() This function not only returns true if there are active handles or requests. First of all, it also takes into account whether handles are referenced. Second, handles that are being closed also contribute to whether a loop is alive. Fixes: https://github.com/libuv/libuv/issues/1592 PR-URL: https://github.com/libuv/libuv/pull/1594 Reviewed-By: Ben Noordhuis Reviewed-By: Santiago Gimeno --- docs/src/loop.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/src/loop.rst b/docs/src/loop.rst index c63f8139..18dd135c 100644 --- a/docs/src/loop.rst +++ b/docs/src/loop.rst @@ -109,7 +109,8 @@ API .. c:function:: int uv_loop_alive(const uv_loop_t* loop) - Returns non-zero if there are active handles or request in the loop. + Returns non-zero if there are referenced active handles, active + requests or closing handles in the loop. .. c:function:: void uv_stop(uv_loop_t* loop)