Class IObject

include/sdbus-c++/IObject.h:62–423

/ * @class IObject * * IObject class represents a D-Bus object instance identified by a specific object path. * D-Bus object provides its interfaces, methods, signals and properties on a bus * identified by a specific bus name. * * All IObject member methods throw @c sdbus::Error in case of D-Bus or sdbus-c++ error. * The IObject class has been designed as thread

     *
     ***********************************************/
    class IObject
    {
    public: // High-level, convenience API
        virtual ~IObject() = default;

        /*!
         * @brief Adds a declaration of methods, properties and signals of the object at a given interface
         *
         * @param[in] vtable Individual instances of VTable item structures stored in a vector
         * @return VTableAdder high-level helper class
         *
         * This method is used to declare attributes for the object under the given interface.
         * Parameter `vtable' represents a vtable definition that may contain method declarations
         * (using MethodVTableItem struct), property declarations (using PropertyVTableItem
         * struct), signal declarations (using SignalVTableItem struct), or global interface
         * flags (using InterfaceFlagsVTableItem struct).
         *
         * An interface can have any number of vtables attached to it.
         *
         * Consult manual pages for the underlying `sd_bus_add_object_vtable` function for more information.
         *
         * The method can be called at any time during object's lifetime.
         *
         * When called like `addVTable(vtable).forInterface(interface)`, then an internal registration
         * slot is created for that vtable and its lifetime is tied to the lifetime of the Object instance.
         * When called like `addVTable(items...).forInterface(interface, sdbus::return_slot)`, then an internal
         * registration slot is created for the vtable and is returned to the caller. Keeping the slot means
         * keep the registration "alive". Destroying the slot means that the vtable is not needed anymore,
         * and the vtable gets removed from the object. This allows for "dynamic" object API where vtables
         * can be added or removed by the user at runtime.
         *
         * The function provides strong exception guarantee. The state of the object remains
         * unmodified in face of an exception.
         *
         * @throws sdbus::Error in case of failure
         */
        [[nodiscard]] VTableAdder addVTable(std::vector<VTableItem> vtable);

        /*!
         * @brief Adds a declaration of methods, properties and signals of the object at a given interface
         *
         * @param[in] items Individual instances of VTable item structures
         * @return VTableAdder high-level helper class
         *
         * This method is used to declare attributes for the object under the given interface.
         * Parameter pack contains vtable definition that may contain method declarations
         * (using MethodVTableItem struct), property declarations (using PropertyVTableItem
         * struct), signal declarations (using SignalVTableItem struct), or global interface
         * flags (using InterfaceFlagsVTableItem struct).
         *
         * An interface can have any number of vtables attached to it.
         *
         * Consult manual pages for the underlying `sd_bus_add_object_vtable` function for more information.
         *
         * The method can be called at any time during object's lifetime.
         *
         * When called like `addVTable(items...).forInterface(interface)`, then an internal registration
         * slot is created for that vtable and its lifetime is tied to the lifetime of the Object instance.