You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/modules.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ It abstracts all of libmodule internals mechanisms to provide an easy-to-use and
59
59
60
60
.. c:macro:: modules_dispatch(ret)
61
61
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).
63
63
64
64
: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.
65
65
:type ret::c:type:`int *`
@@ -115,7 +115,7 @@ It exposes very similar functions to single-context API (again, single-context i
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).
119
119
120
120
:param ctx_name: context name.
121
121
: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