sd_bus_set_close_on_exit(3) — Linux manual page

SD_BUS_S..._ON_EXIT(3)  sd_bus_set_close_on_exit  SD_BUS_S..._ON_EXIT(3)

NAME

       sd_bus_set_close_on_exit, sd_bus_get_close_on_exit - Control
       whether to close the bus connection during the event loop exit
       phase

SYNOPSIS

       #include <systemd/sd-bus.h>

       int sd_bus_set_close_on_exit(sd_bus *bus, int b);

       int sd_bus_get_close_on_exit(sd_bus *bus);

DESCRIPTION

       sd_bus_set_close_on_exit() may be used to enable or disable
       whether the bus connection is automatically flushed (as in
       sd_bus_flush(3)) and closed (as in sd_bus_close(3)) during the
       exit phase of the event loop. This logic only applies to bus
       connections that are attached to an sd-event(3) event loop, see
       sd_bus_attach_event(3). By default this mechanism is enabled and
       makes sure that any pending messages that have not been written
       to the bus connection are written out when the event loop is
       shutting down. In some cases this behaviour is not desirable, for
       example when the bus connection shall remain usable until after
       the event loop exited. If b is true, the feature is enabled
       (which is the default), otherwise disabled.

       sd_bus_get_close_on_exit() may be used to query the current
       setting of this feature. It returns zero when the feature is
       disabled, and positive if enabled.

RETURN VALUE

       On success, sd_bus_set_close_on_exit() returns a non-negative
       integer. On failure, it returns a negative errno-style error
       code.

       sd_bus_get_close_on_exit() returns 0 if the feature is currently
       disabled or a positive integer if it is enabled. On failure, it
       returns a negative errno-style error code.

   Errors
       Returned errors may indicate the following problems:

       -ECHILD
           The bus connection was created in a different process,
           library or module instance.

NOTES

       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

       sd_bus_set_close_on_exit() and sd_bus_get_close_on_exit() were
       added in version 240.

SEE ALSO

       systemd(1), sd-bus(3), sd_bus_flush(3), sd_bus_attach_event(3),
       sd-event(3), sd_event_add_exit(3)

COLOPHON

       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 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-13.)  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 257~devel                                 SD_BUS_S..._ON_EXIT(3)

Pages that refer to this page: sd-bus(3), sd_bus_attach_event(3), sd_bus_close(3), sd_bus_set_fd(3), systemd.directives(7), systemd.index(7)

---