table of contents
- bookworm 252.30-1~deb12u2
- bookworm-backports 254.16-1~bpo12+1
- testing 256.6-1
- unstable 256.7-1
SD_EVENT_SOURCE_SET_EXIT_ON_FAILURE(3) | sd_event_source_set_exit_on_failure | SD_EVENT_SOURCE_SET_EXIT_ON_FAILURE(3) |
NAME¶
sd_event_source_set_exit_on_failure, sd_event_source_get_exit_on_failure - Set or retrieve the exit-on-failure feature of event sources
SYNOPSIS¶
#include <systemd/sd-event.h>
int sd_event_source_set_exit_on_failure(sd_event_source *source, int b);
int sd_event_source_get_exit_on_failure(sd_event_source *source);
DESCRIPTION¶
sd_event_source_set_exit_on_failure() may be used to set/unset the exit-on-failure flag of the event source object specified as source. The flag defaults to off. If on and the callback function set for the event source returns a failure code (i.e. a negative value) the event loop is exited too, using the callback return code as the exit code for sd_event_exit(3). If off, the event source is disabled but the event loop continues to run. Setting this flag is useful for "dominant" event sources that define the purpose and reason for the event loop, and whose failure hence should propagate to the event loop itself — as opposed to "auxiliary" event sources whose failures should remain local and affect the event source, but not propagate further.
sd_event_source_get_exit_on_failure() may be used to query the flag currently set for the event source object source.
RETURN VALUE¶
On success, sd_event_source_set_exit_on_failure() returns a non-negative integer. sd_event_source_get_exit_on_failure() returns 0 if the flag is off, > 0 if the flag is on. On failure, both return a negative errno-style error code.
Errors¶
Returned errors may indicate the following problems:
-EINVAL
-EDOM
NOTES¶
These APIs are implemented as a shared library, which can be compiled and linked to with the libsystemd pkg-config(1) file.
SEE ALSO¶
sd-event(3), sd_event_add_io(3), sd_event_add_time(3), sd_event_add_signal(3), sd_event_add_child(3), sd_event_add_inotify(3), sd_event_add_defer(3)
systemd 252 |