Skip to content

Commit 5d5be51

Browse files
committed
Updated doc.
1 parent deebffc commit 5d5be51

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/src/modules.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ It abstracts all of libmodule internals mechanisms to provide an easy-to-use and
5959

6060
.. c:macro:: modules_dispatch(ret)
6161
62-
Dispatch libmodule's messages. Useful when libmodule's loop is integrated inside an external loop.
62+
Dispatch libmodule's messages. Useful when libmodule's loop is integrated inside an external loop. This is a non-blocking function (ie: if no data is available to be dispatched, it will return).
6363

6464
:param ret: ret >= 0 and MOD_OK returned -> number of dispatched messages. ret >= 0 and MOD_ERR returned -> loop has been quitted by a modules_quit() code, thus it returns quit_code. Ret < 0 and MOD_ERR returned: an error happened.
6565
:type ret: :c:type:`int *`
@@ -115,7 +115,7 @@ It exposes very similar functions to single-context API (again, single-context i
115115

116116
.. c:function:: modules_ctx_dispatch(ctx_name, ret)
117117
118-
Dispatch libmodule's messages. Useful when libmodule's loop is integrated inside an external loop.
118+
Dispatch libmodule's messages. Useful when libmodule's loop is integrated inside an external loop. This is a non-blocking function (ie: if no data is available to be dispatched, it will return).
119119

120120
:param ctx_name: context name.
121121
:param ret: ret >= 0 and MOD_OK returned -> number of dispatched messages. ret >= 0 and MOD_ERR returned -> loop has been quitted by a modules_quit() code, thus it returns quit_code. Ret < 0 and MOD_ERR returned: an error happened.

0 commit comments

Comments
 (0)