sd_bus_add_object_manager(3) — Linux manual page


SD_BUS_A...T_MANAGER(3) sd_bus_add_object_managerSD_BUS_A...T_MANAGER(3)

NAME         top

       sd_bus_add_object_manager - Add a D-Bus object manager for a
       D-Bus object sub-tree

SYNOPSIS         top

       #include <systemd/sd-bus.h>

       int sd_bus_add_object_manager(sd_bus *bus, sd_bus_slot **slot,
                                     const char *path);

DESCRIPTION         top

       sd_bus_add_object_manager() installs a handler for the given path
       that implements the GetManagedObjects() method of the
       org.freedesktop.DBus.ObjectManager interface. See
       org.freedesktop.DBus.ObjectManager[1] for more information.

       To implement the InterfacesAdded and InterfacesRemoved signals of
       the org.freedesktop.DBus.ObjectManager interface, call
       sd_bus_emit_interfaces_added(3) and
       sd_bus_emit_interfaces_removed(3) whenever interfaces are added
       or removed from the sub-tree, respectively.

       When sd_bus_add_object_manager() succeeds, a slot is created
       internally. If the output parameter slot is NULL, a "floating"
       slot object is created, see sd_bus_slot_set_floating(3).
       Otherwise, a pointer to the slot object is returned. In that
       case, the reference to the slot object should be dropped when the
       object manager is not needed anymore, see sd_bus_slot_unref(3).

RETURN VALUE         top

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

       Returned errors may indicate the following problems:

           One of the required parameters is NULL or path is not a valid
           object path.

           Added in version 246.

           The bus cannot be resolved.

           Added in version 246.

           The bus was created in a different process, library or module

           Added in version 246.

           Memory allocation failed.

           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

HISTORY         top

       sd_bus_add_object_manager() was added in version 246.

SEE ALSO         top

       sd-bus(3), busctl(1), sd_bus_add_object_vtable(3),
       sd_bus_emit_interfaces_added(3), sd_bus_slot_unref(3)

NOTES         top

        1. org.freedesktop.DBus.ObjectManager

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨⟩.  If you have
       a bug report for this manual page, see
       This page was obtained from the project's upstream Git repository
       ⟨⟩ 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

systemd 255                                      SD_BUS_A...T_MANAGER(3)

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