Skip to content

Commit

Permalink
flux_msg_handler_create(3): add get_handle_watcher
Browse files Browse the repository at this point in the history
Problem: flux_get_handle_watcher() is not documented.

Add it to the message handler man page.
  • Loading branch information
garlick committed Dec 23, 2024
1 parent d2d8171 commit 075c604
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
1 change: 1 addition & 0 deletions doc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,7 @@ MAN3_FILES_SECONDARY = \
man3/flux_msg_handler_destroy.3 \
man3/flux_msg_handler_start.3 \
man3/flux_msg_handler_stop.3 \
man3/flux_get_handle_watcher.3 \
man3/flux_msg_handler_delvec.3 \
man3/flux_child_watcher_get_rpid.3 \
man3/flux_child_watcher_get_rstatus.3 \
Expand Down
5 changes: 4 additions & 1 deletion doc/man3/flux_msg_handler_create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ SYNOPSIS
void flux_msg_handler_stop (flux_msg_handler_t *mh);
flux_watcher_t *flux_get_handle_watcher(flux_t *h)
Link with :command:`-lflux-core`.

DESCRIPTION
Expand All @@ -46,7 +48,8 @@ The handle :var:`h` is monitored for FLUX_POLLIN events on the
:type:`flux_reactor_t` associated with the handle as described in
:man3:`flux_set_reactor`. This internal "handle watcher" is started when the
first message handler is started, and stopped when the last message handler
is stopped.
is stopped. The handle watcher may be directly accessed with
:func:`flux_get_handle_watcher`.

Messages arriving on :var:`h` are internally read and dispatched to matching
message handlers. If multiple handlers match the message, the following
Expand Down
1 change: 1 addition & 0 deletions doc/manpages.py
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@
('man3/flux_msg_handler_create', 'flux_msg_handler_start', 'manage message handlers', [author], 3),
('man3/flux_msg_handler_create', 'flux_msg_handler_stop', 'manage message handlers', [author], 3),
('man3/flux_msg_handler_create', 'flux_msg_handler_create', 'manage message handlers', [author], 3),
('man3/flux_msg_handler_create', 'flux_get_handle_watcher', 'manage message handlers', [author], 3),
('man3/flux_open', 'flux_clone', 'open/close connection to Flux Message Broker', [author], 3),
('man3/flux_open', 'flux_close', 'open/close connection to Flux Message Broker', [author], 3),
('man3/flux_open', 'flux_open', 'open/close connection to Flux Message Broker', [author], 3),
Expand Down

0 comments on commit 075c604

Please sign in to comment.