flux_module_set_running(3)

SYNOPSIS

#include <flux/core.h>

int flux_module_set_running (flux_t *h);

bool flux_module_debug_test (flux_t *h, int flag, bool clear);

int flux_module_config_request_decode (const flux_msg_t *msg,
                                       flux_conf_t **conf);

Link with -lflux-core.

DESCRIPTION

flux_module_set_running() sets the broker module state to RUNNING. A module load request blocks until the module reaches this state to ensure that any fatal module initialization errors are reported. The transition to RUNNING occurs automatically when the reactor is entered. This function can set the state to RUNNING to finalize the load request earlier if necessary.

flux_module_debug_test() tests and optionally clears flags in the RFC 5 module debug mask. The module debug mask is normally clear, but the flux module debug command may be used to alter the mask to create test conditions. The meanings of specific the flag bits are module-dependent.

flux_module_config_request_decode() decodes a config-reload request message sent by the broker. It creates a config object conf that contains the proposed config. This is helpful when a broker module overrides the default request handler for config-reload in order to respond to dynamic configuration changes.

RETURN VALUE

flux_module_set_running() returns 0 on success, or -1 on failure with On error, NULL is returned, and errno is set. errno set.

flux_module_debug_test() returns true if the specified debug flag is set.

flux_module_config_request_decode() returns 0 on success, or -1 on failure with errno set.

ERRORS

EINVAL: Invalid argument.
ENOMEM: Out of memory.

RESOURCES

Flux: http://flux-framework.org

Flux RFC: https://flux-framework.readthedocs.io/projects/flux-rfc

Issue Tracker: https://github.com/flux-framework/flux-core/issues

FLUX RFC

5/Flux Broker Modules