sd_event_source_set_exit_on_failure(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | SEE ALSO | COLOPHON

SD_EVENT_SOURCE_SET_EXIT_ON_FAILURE(3)_exit_on_failureEXIT_ON_FAILURE(3)

NAME         top

       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         top

       #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         top

       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         top

       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
           source is not a valid pointer to an sd_event_source object.

       -EDOM
           The event source refers to an exit event source (as created
           with sd_event_add_exit(3)), for which this functionality is
           not supported.

NOTES         top

       These APIs are implemented as a shared library, which can be
       compiled and linked to with the libsystemd pkg-config(1) file.

SEE ALSO         top

       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)

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have
       a bug report for this manual page, see
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ on 2021-06-20.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2021-06-19.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 249                       SD_EVENT_SOURCE_SET_EXIT_ON_FAILURE(3)

Pages that refer to this page: systemd.directives(7)systemd.index(7)