sd_bus_set_method_call_timeout(3) — Linux manual page

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

SD_BUS_...TIMEOUT(3) sd_bus_set_method_call_timeout SD_BUS_...TIMEOUT(3)

NAME         top

       sd_bus_set_method_call_timeout, sd_bus_get_method_call_timeout -
       Set or query the default D-Bus method call timeout of a bus
       object

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_set_method_call_timeout(sd_bus *bus, uint64_t usec);

       int sd_bus_get_method_call_timeout(sd_bus *bus, uint64_t *ret);

DESCRIPTION         top

       sd_bus_set_method_call_timeout() sets the default D-Bus method
       call timeout of bus to usec microseconds.

       sd_bus_get_method_call_timeout() queries the default D-Bus method
       call timeout of bus. If no method call timeout was set using
       sd_bus_set_method_call_timeout(), the timeout is read from the
       $SYSTEMD_BUS_TIMEOUT environment variable. If this environment
       variable is unset or does not contain a valid timeout, the
       implementation falls back to a predefined method call timeout of
       25 seconds. Note that $SYSTEMD_BUS_TIMEOUT is read once and
       cached so callers should not rely on being able to change the
       default method call timeout at runtime by changing the value of
       $SYSTEMD_BUS_TIMEOUT. Instead, call
       sd_bus_set_method_call_timeout() to change the default method
       call timeout.

RETURN VALUE         top

       On success, these functions return a non-negative integer. On
       failure, they return a negative errno-style error code.

   Errors
       Returned errors may indicate the following problems:

       -EINVAL
           The parameters bus or ret are NULL.

           Added in version 246.

       -ENOPKG
           Bus object bus could not be resolved.

           Added in version 246.

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_bus_set_method_call_timeout() and
       sd_bus_get_method_call_timeout() were added in version 246.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_call(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 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-22.)  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 255                                         SD_BUS_...TIMEOUT(3)

Pages that refer to this page: sd-bus(3)sd_bus_call(3)systemd.directives(7)systemd.index(7)