sd_event_set_exit_on_idle(3) — Linux manual page

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

SD_EVENT...T_ON_IDLE(3) sd_event_set_exit_on_idle SD_EVENT...T_ON_IDLE(3)

NAME         top

       sd_event_set_exit_on_idle, sd_event_get_exit_on_idle - Enable
       event loop exit-on-idle support

SYNOPSIS         top

       #include <systemd/sd-event.h>

       int sd_event_set_exit_on_idle(sd_event *event, int b);

       int sd_event_get_exit_on_idle(sd_event *event);

DESCRIPTION         top

       sd_event_set_exit_on_idle() may be used to enable or disable the
       exit-on-idle support in the event loop object specified in the
       event parameter. If enabled, the event loop will exit with a zero
       exit code there are no more enabled (SD_EVENT_ON,
       SD_EVENT_ONESHOT), non-exit, non-post event sources.

       sd_event_get_exit_on_idle() may be used to determine whether
       exit-on-idle support was previously requested by a call to
       sd_event_set_exit_on_idle() with a true b parameter and
       successfully enabled.

RETURN VALUE         top

       On success, sd_event_set_exit_on_idle() and
       sd_event_get_exit_on_idle() return a non-zero positive integer if
       the exit-on-idle support was successfully enabled. They return
       zero if the exit-on-idle support was explicitly disabled with a
       false b parameter. On failure, they return a negative errno-style
       error code.

   Errors
       Returned errors may indicate the following problems:

       -ECHILD
           The event loop has been created in a different process,
           library or module instance.

       -EINVAL
           The passed event loop object was invalid.

NOTES         top

       Functions described here are available as a shared library, which
       can be compiled against and linked to with the
       libsystemd pkg-config(1) file.

       The code described here uses getenv(3), which is declared to be
       not multi-thread-safe. This means that the code calling the
       functions described here must not call setenv(3) from a parallel
       thread. It is recommended to only do calls to setenv() from an
       early phase of the program when no other threads have been
       started.

HISTORY         top

       sd_event_set_exit_on_idle() and sd_event_get_exit_on_idle() were
       added in version 259.

SEE ALSO         top

       systemd(1), sd-event(3), sd_event_new(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.service(5)

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 2026-01-16.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2026-01-16.)  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 260~devel                                 SD_EVENT...T_ON_IDLE(3)

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