ConvenienceApiClasses.inl

Go to the documentation of this file.

 
#ifndef SDBUS_CPP_CONVENIENCEAPICLASSES_INL_
#define SDBUS_CPP_CONVENIENCEAPICLASSES_INL_
 
#include <sdbus-c++/Error.h>
#include <sdbus-c++/IObject.h> // NOLINT(misc-header-include-cycle)
#include <sdbus-c++/IProxy.h> // NOLINT(misc-header-include-cycle)
#include <sdbus-c++/Message.h>
#include <sdbus-c++/MethodResult.h>
#include <sdbus-c++/TypeTraits.h>
#include <sdbus-c++/Types.h>
 
#include <cassert>
#include <exception>
#include <string>
#include <tuple>
#include <type_traits>
 
namespace sdbus {
 
    /*** ------------- ***/
    /***  VTableAdder  ***/
    /*** ------------- ***/
 
    inline VTableAdder::VTableAdder(IObject& object, std::vector<VTableItem> vtable)
        : object_(object)
        , vtable_(std::move(vtable))
    {
    }
 
    inline void VTableAdder::forInterface(InterfaceName interfaceName)
    {
        object_.addVTable(std::move(interfaceName), std::move(vtable_));
    }
 
    inline void VTableAdder::forInterface(std::string interfaceName)
    {
        forInterface(InterfaceName{std::move(interfaceName)});
    }
 
    [[nodiscard]] inline Slot VTableAdder::forInterface(InterfaceName interfaceName, return_slot_t)
    {
        return object_.addVTable(std::move(interfaceName), std::move(vtable_), return_slot);
    }
 
    [[nodiscard]] inline Slot VTableAdder::forInterface(std::string interfaceName, return_slot_t)
    {
        return forInterface(InterfaceName{std::move(interfaceName)}, return_slot);
    }
 
    /*** ------------- ***/
    /*** SignalEmitter ***/
    /*** ------------- ***/
 
    inline SignalEmitter::SignalEmitter(IObject& object, const SignalName& signalName)
        : SignalEmitter(object, signalName.c_str())
    {
    }
 
    inline SignalEmitter::SignalEmitter(IObject& object, const char* signalName)
        : object_(object)
        , signalName_(signalName)
        , exceptions_(std::uncaught_exceptions())
    {
    }
 
    inline SignalEmitter::~SignalEmitter() noexcept(false) // since C++11, destructors must
    {                                                      // explicitly be allowed to throw
        // Don't emit the signal if SignalEmitter threw an exception in one of its methods
        if (std::uncaught_exceptions() != exceptions_)
            return;
 
        // emitSignal() can throw. But as the SignalEmitter shall always be used as an unnamed,
        // temporary object, i.e. not as a stack-allocated object, the double-exception situation
        // shall never happen. I.e. it should not happen that this destructor is directly called
        // in the stack-unwinding process of another flying exception (which would lead to immediate
        // termination). It can be called indirectly in the destructor of another object, but that's
        // fine and safe provided that the caller catches exceptions thrown from here.
        // Therefore, we can allow emitSignal() to throw even if we are in the destructor.
        // Bottomline is, to be on the safe side, the caller must take care of catching and reacting
        // to the exception thrown from here if the caller is a destructor itself.
        object_.emitSignal(signal_);
    }
 
    inline SignalEmitter& SignalEmitter::onInterface(const InterfaceName& interfaceName)
    {
        return onInterface(interfaceName.c_str());
    }
 
    inline SignalEmitter& SignalEmitter::onInterface(const std::string& interfaceName)
    {
        return onInterface(interfaceName.c_str());
    }
 
    inline SignalEmitter& SignalEmitter::onInterface(const char* interfaceName)
    {
        signal_ = object_.createSignal(interfaceName, signalName_);
 
        return *this;
    }
 
    template <typename... Args>
    inline void SignalEmitter::withArguments(Args&&... args)
    {
        assert(signal_.isValid()); // onInterface() must be placed/called prior to withArguments()
 
        detail::serialize_pack(signal_, std::forward<Args>(args)...);
    }
 
    /*** ------------- ***/
    /*** MethodInvoker ***/
    /*** ------------- ***/
 
    inline MethodInvoker::MethodInvoker(IProxy& proxy, const MethodName& methodName)
        : MethodInvoker(proxy, methodName.c_str())
    {
    }
 
    inline MethodInvoker::MethodInvoker(IProxy& proxy, const char* methodName)
        : proxy_(proxy)
        , methodName_(methodName)
        , exceptions_(std::uncaught_exceptions())
    {
    }
 
    inline MethodInvoker::~MethodInvoker() noexcept(false) // since C++11, destructors must
    {                                                      // explicitly be allowed to throw
        // Don't call the method if it has been called already or if MethodInvoker
        // threw an exception in one of its methods
        if (methodCalled_ || std::uncaught_exceptions() != exceptions_)
            return;
 
        // callMethod() can throw. But as the MethodInvoker shall always be used as an unnamed,
        // temporary object, i.e. not as a stack-allocated object, the double-exception situation
        // shall never happen. I.e. it should not happen that this destructor is directly called
        // in the stack-unwinding process of another flying exception (which would lead to immediate
        // termination). It can be called indirectly in the destructor of another object, but that's
        // fine and safe provided that the caller catches exceptions thrown from here.
        // Therefore, we can allow callMethod() to throw even if we are in the destructor.
        // Bottomline is, to be on the safe side, the caller must take care of catching and reacting
        // to the exception thrown from here if the caller is a destructor itself.
        proxy_.callMethod(method_, timeout_);
    }
 
    inline MethodInvoker& MethodInvoker::onInterface(const InterfaceName& interfaceName)
    {
        return onInterface(interfaceName.c_str());
    }
 
    inline MethodInvoker& MethodInvoker::onInterface(const std::string& interfaceName)
    {
        return onInterface(interfaceName.c_str());
    }
 
    inline MethodInvoker& MethodInvoker::onInterface(const char* interfaceName)
    {
        method_ = proxy_.createMethodCall(interfaceName, methodName_);
 
        return *this;
    }
 
    inline MethodInvoker& MethodInvoker::withTimeout(uint64_t usec)
    {
        timeout_ = usec;
 
        return *this;
    }
 
    template <typename Rep, typename Period>
    inline MethodInvoker& MethodInvoker::withTimeout(const std::chrono::duration<Rep, Period>& timeout)
    {
        auto microsecs = std::chrono::duration_cast<std::chrono::microseconds>(timeout);
        return withTimeout(microsecs.count());
    }
 
    template <typename... Args>
    inline MethodInvoker& MethodInvoker::withArguments(Args&&... args)
    {
        assert(method_.isValid()); // onInterface() must be placed/called prior to this function
 
        detail::serialize_pack(method_, std::forward<Args>(args)...);
 
        return *this;
    }
 
    template <typename... Args>
    inline void MethodInvoker::storeResultsTo(Args&... args)
    {
        assert(method_.isValid()); // onInterface() must be placed/called prior to this function
 
        auto reply = proxy_.callMethod(method_, timeout_);
        methodCalled_ = true;
 
        detail::deserialize_pack(reply, args...);
    }
 
    inline void MethodInvoker::dontExpectReply()
    {
        assert(method_.isValid()); // onInterface() must be placed/called prior to this function
 
        method_.dontExpectReply();
    }
 
    /*** ------------------ ***/
    /*** AsyncMethodInvoker ***/
    /*** ------------------ ***/
 
    inline AsyncMethodInvoker::AsyncMethodInvoker(IProxy& proxy, const MethodName& methodName)
        : AsyncMethodInvoker(proxy, methodName.c_str())
    {
    }
 
    inline AsyncMethodInvoker::AsyncMethodInvoker(IProxy& proxy, const char* methodName)
        : proxy_(proxy)
        , methodName_(methodName)
    {
    }
 
    inline AsyncMethodInvoker& AsyncMethodInvoker::onInterface(const InterfaceName& interfaceName)
    {
        return onInterface(interfaceName.c_str());
    }
 
    inline AsyncMethodInvoker& AsyncMethodInvoker::onInterface(const std::string& interfaceName)
    {
        return onInterface(interfaceName.c_str());
    }
 
    inline AsyncMethodInvoker& AsyncMethodInvoker::onInterface(const char* interfaceName)
    {
        method_ = proxy_.createMethodCall(interfaceName, methodName_);
 
        return *this;
    }
 
    inline AsyncMethodInvoker& AsyncMethodInvoker::withTimeout(uint64_t usec)
    {
        timeout_ = usec;
 
        return *this;
    }
 
    template <typename Rep, typename Period>
    inline AsyncMethodInvoker& AsyncMethodInvoker::withTimeout(const std::chrono::duration<Rep, Period>& timeout)
    {
        auto microsecs = std::chrono::duration_cast<std::chrono::microseconds>(timeout);
        return withTimeout(microsecs.count());
    }
 
    template <typename... Args>
    inline AsyncMethodInvoker& AsyncMethodInvoker::withArguments(Args&&... args)
    {
        assert(method_.isValid()); // onInterface() must be placed/called prior to this function
 
        detail::serialize_pack(method_, std::forward<Args>(args)...);
 
        return *this;
    }
 
    template <typename Function>
    PendingAsyncCall AsyncMethodInvoker::uponReplyInvoke(Function&& callback)
    {
        assert(method_.isValid()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync(method_, makeAsyncReplyHandler(std::forward<Function>(callback)), timeout_);
    }
 
    template <typename Function>
    [[nodiscard]] Slot AsyncMethodInvoker::uponReplyInvoke(Function&& callback, return_slot_t)
    {
        assert(method_.isValid()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync( method_
                                     , makeAsyncReplyHandler(std::forward<Function>(callback))
                                     , timeout_
                                     , return_slot );
    }
 
    template <typename Function>
    inline async_reply_handler AsyncMethodInvoker::makeAsyncReplyHandler(Function&& callback)
    {
        return [callback = std::forward<Function>(callback)](MethodReply reply, std::optional<Error> error)
        {
            // Create a tuple of callback input arguments' types, which will be used
            // as a storage for the argument values deserialized from the message.
            tuple_of_function_input_arg_types_t<Function> args;
 
            // Deserialize input arguments from the message into the tuple (if no error occurred).
            if (!error)
            {
                try
                {
                    reply >> args;
                }
                catch (const Error& e)
                {
                    // Pass message deserialization exceptions to the client via callback error parameter,
                    // instead of propagating them up the message loop call stack.
                    sdbus::apply(callback, e, args);
                    return;
                }
            }
 
            // Invoke callback with input arguments from the tuple.
            sdbus::apply(callback, std::move(error), args);
        };
    }
 
    template <typename... Args>
    std::future<future_return_t<Args...>> AsyncMethodInvoker::getResultAsFuture()
    {
        auto promise = std::make_shared<std::promise<future_return_t<Args...>>>();
        auto future = promise->get_future();
 
        uponReplyInvoke([promise = std::move(promise)](std::optional<Error> error, Args... args)
        {
            if (!error)
                if constexpr (!std::is_void_v<future_return_t<Args...>>)
                    promise->set_value({std::move(args)...});
                else
                    promise->set_value();
            else
                promise->set_exception(std::make_exception_ptr(*std::move(error)));
        });
 
        // Will be std::future<void> for no D-Bus method return value
        //      or std::future<T> for single D-Bus method return value
        //      or std::future<std::tuple<...>> for multiple method return values
        return future;
    }
 
    template <typename... Args>
    Awaitable<awaitable_return_t<Args...>> AsyncMethodInvoker::getResultAsAwaitable()
    {
        // awaitable_return_t<Args...> will be void for no D-Bus method return value
        //                                  or T for single D-Bus method return value
        //                                  or std::tuple<...> for multiple method return values
        auto data = std::make_shared<AwaitableData<awaitable_return_t<Args...>>>();
 
        uponReplyInvoke([data](std::optional<Error> error, Args... args)
        {
            if (!error)
                if constexpr (!std::is_void_v<awaitable_return_t<Args...>>)
                    data->result = {std::move(args)...};
                else
                    data->result = std::monostate{};
            else
                data->result = std::make_exception_ptr(*std::move(error));
 
            auto previous = data->status.exchange(AwaitableState::Completed, std::memory_order_acq_rel);
            if (previous == AwaitableState::Waiting)
                data->resumeCoroutine();
        });
 
        return Awaitable(data);
    }
 
    /*** ---------------- ***/
    /*** SignalSubscriber ***/
    /*** ---------------- ***/
 
    inline SignalSubscriber::SignalSubscriber(IProxy& proxy, const SignalName& signalName)
        : SignalSubscriber(proxy, signalName.c_str())
    {
    }
 
    inline SignalSubscriber::SignalSubscriber(IProxy& proxy, const char* signalName)
        : proxy_(proxy)
        , signalName_(signalName)
    {
    }
 
    inline SignalSubscriber& SignalSubscriber::onInterface(const InterfaceName& interfaceName)
    {
        return onInterface(interfaceName.c_str());
    }
 
    inline SignalSubscriber& SignalSubscriber::onInterface(const std::string& interfaceName)
    {
        return onInterface(interfaceName.c_str());
    }
 
    inline SignalSubscriber& SignalSubscriber::onInterface(const char* interfaceName)
    {
        interfaceName_ = std::move(interfaceName);
 
        return *this;
    }
 
    template <typename Function>
    inline void SignalSubscriber::call(Function&& callback)
    {
        assert(interfaceName_ != nullptr); // onInterface() must be placed/called prior to this function
 
        proxy_.registerSignalHandler( interfaceName_
                                    , signalName_
                                    , makeSignalHandler(std::forward<Function>(callback)) );
    }
 
    template <typename Function>
    [[nodiscard]] inline Slot SignalSubscriber::call(Function&& callback, return_slot_t)
    {
        assert(interfaceName_ != nullptr); // onInterface() must be placed/called prior to this function
 
        return proxy_.registerSignalHandler( interfaceName_
                                           , signalName_
                                           , makeSignalHandler(std::forward<Function>(callback))
                                           , return_slot );
    }
 
    template <typename Function>
    inline signal_handler SignalSubscriber::makeSignalHandler(Function&& callback)
    {
        return [callback = std::forward<Function>(callback)](Signal signal)
        {
            // Create a tuple of callback input arguments' types, which will be used
            // as a storage for the argument values deserialized from the signal message.
            tuple_of_function_input_arg_types_t<Function> signalArgs;
 
            // The signal handler can take pure signal parameters only, or an additional `std::optional<Error>` as its first
            // parameter. In the former case, if the deserialization fails (e.g. due to signature mismatch),
            // the failure is ignored (and signal simply dropped). In the latter case, the deserialization failure
            // will be communicated to the client's signal handler as a valid Error object inside the std::optional parameter.
            if constexpr (has_error_param_v<Function>)
            {
                // Deserialize input arguments from the signal message into the tuple
                try
                {
                    signal >> signalArgs;
                }
                catch (const Error& e)
                {
                    // Pass message deserialization exceptions to the client via callback error parameter,
                    // instead of propagating them up the message loop call stack.
                    sdbus::apply(callback, e, signalArgs);
                    return;
                }
 
                // Invoke callback with no error and input arguments from the tuple.
                sdbus::apply(callback, {}, signalArgs);
            }
            else
            {
                // Deserialize input arguments from the signal message into the tuple
                signal >> signalArgs;
 
                // Invoke callback with input arguments from the tuple.
                sdbus::apply(callback, signalArgs);
            }
        };
    }
 
    /*** -------------- ***/
    /*** PropertyGetter ***/
    /*** -------------- ***/
 
    inline PropertyGetter::PropertyGetter(IProxy& proxy, std::string_view propertyName)
        : proxy_(proxy)
        , propertyName_(std::move(propertyName))
    {
    }
 
    inline Variant PropertyGetter::onInterface(std::string_view interfaceName)
    {
        Variant var;
        proxy_.callMethod("Get")
              .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
              .withArguments(interfaceName, propertyName_)
              .storeResultsTo(var);
        return var;
    }
 
    /*** ------------------- ***/
    /*** AsyncPropertyGetter ***/
    /*** ------------------- ***/
 
    inline AsyncPropertyGetter::AsyncPropertyGetter(IProxy& proxy, std::string_view propertyName)
        : proxy_(proxy)
        , propertyName_(std::move(propertyName))
    {
    }
 
    inline AsyncPropertyGetter& AsyncPropertyGetter::onInterface(std::string_view interfaceName)
    {
        interfaceName_ = std::move(interfaceName);
 
        return *this;
    }
 
    template <typename Function>
    PendingAsyncCall AsyncPropertyGetter::uponReplyInvoke(Function&& callback)
    {
        static_assert( std::is_invocable_r_v<void, Function, std::optional<Error>, Variant>
                     , "Property get callback function must accept std::optional<Error> and property value as Variant" );
 
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("Get")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_, propertyName_)
                     .uponReplyInvoke(std::forward<Function>(callback));
    }
 
    template <typename Function>
    [[nodiscard]] Slot AsyncPropertyGetter::uponReplyInvoke(Function&& callback, return_slot_t)
    {
        static_assert( std::is_invocable_r_v<void, Function, std::optional<Error>, Variant>
                     , "Property get callback function must accept std::optional<Error> and property value as Variant" );
 
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("Get")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_, propertyName_)
                     .uponReplyInvoke(std::forward<Function>(callback), return_slot);
    }
 
    inline std::future<Variant> AsyncPropertyGetter::getResultAsFuture()
    {
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("Get")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_, propertyName_)
                     .getResultAsFuture<Variant>();
    }
 
    inline Awaitable<Variant> AsyncPropertyGetter::getResultAsAwaitable()
    {
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("Get")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_, propertyName_)
                     .getResultAsAwaitable<Variant>();
    }
 
    /*** -------------- ***/
    /*** PropertySetter ***/
    /*** -------------- ***/
 
    inline PropertySetter::PropertySetter(IProxy& proxy, std::string_view propertyName)
        : proxy_(proxy)
        , propertyName_(std::move(propertyName))
    {
    }
 
    inline PropertySetter& PropertySetter::onInterface(std::string_view interfaceName)
    {
        interfaceName_ = std::move(interfaceName);
 
        return *this;
    }
 
    template <typename Value>
    inline void PropertySetter::toValue(const Value& value)
    {
        PropertySetter::toValue(Variant{value});
    }
 
    template <typename Value>
    inline void PropertySetter::toValue(const Value& value, dont_expect_reply_t)
    {
        PropertySetter::toValue(Variant{value}, dont_expect_reply);
    }
 
    inline void PropertySetter::toValue(const Variant& value)
    {
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        proxy_.callMethod("Set")
              .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
              .withArguments(interfaceName_, propertyName_, value);
    }
 
    inline void PropertySetter::toValue(const Variant& value, dont_expect_reply_t)
    {
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        proxy_.callMethod("Set")
              .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
              .withArguments(interfaceName_, propertyName_, value)
              .dontExpectReply();
    }
 
    /*** ------------------- ***/
    /*** AsyncPropertySetter ***/
    /*** ------------------- ***/
 
    inline AsyncPropertySetter::AsyncPropertySetter(IProxy& proxy, std::string_view propertyName)
        : proxy_(proxy)
        , propertyName_(propertyName)
    {
    }
 
    inline AsyncPropertySetter& AsyncPropertySetter::onInterface(std::string_view interfaceName)
    {
        interfaceName_ = std::move(interfaceName);
 
        return *this;
    }
 
    template <typename Value>
    inline AsyncPropertySetter& AsyncPropertySetter::toValue(Value&& value)
    {
        return AsyncPropertySetter::toValue(Variant{std::forward<Value>(value)});
    }
 
    inline AsyncPropertySetter& AsyncPropertySetter::toValue(Variant value)
    {
        value_ = std::move(value);
 
        return *this;
    }
 
    template <typename Function>
    PendingAsyncCall AsyncPropertySetter::uponReplyInvoke(Function&& callback)
    {
        static_assert( std::is_invocable_r_v<void, Function, std::optional<Error>>
                     , "Property set callback function must accept std::optional<Error> only" );
 
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("Set")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_, propertyName_, std::move(value_))
                     .uponReplyInvoke(std::forward<Function>(callback));
    }
 
    template <typename Function>
    [[nodiscard]] Slot AsyncPropertySetter::uponReplyInvoke(Function&& callback, return_slot_t)
    {
        static_assert( std::is_invocable_r_v<void, Function, std::optional<Error>>
                     , "Property set callback function must accept std::optional<Error> only" );
 
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("Set")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_, propertyName_, std::move(value_))
                     .uponReplyInvoke(std::forward<Function>(callback), return_slot);
    }
 
    inline std::future<void> AsyncPropertySetter::getResultAsFuture()
    {
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("Set")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_, propertyName_, std::move(value_))
                     .getResultAsFuture<>();
    }
 
    inline Awaitable<void> AsyncPropertySetter::getResultAsAwaitable()
    {
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("Set")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_, propertyName_, std::move(value_))
                     .getResultAsAwaitable<>();
    }
 
    /*** ------------------- ***/
    /*** AllPropertiesGetter ***/
    /*** ------------------- ***/
 
    inline AllPropertiesGetter::AllPropertiesGetter(IProxy& proxy)
        : proxy_(proxy)
    {
    }
 
    inline std::map<PropertyName, Variant> AllPropertiesGetter::onInterface(std::string_view interfaceName)
    {
        std::map<PropertyName, Variant> props;
        proxy_.callMethod("GetAll")
              .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
              .withArguments(std::move(interfaceName))
              .storeResultsTo(props);
        return props;
    }
 
    /*** ------------------------ ***/
    /*** AsyncAllPropertiesGetter ***/
    /*** ------------------------ ***/
 
    inline AsyncAllPropertiesGetter::AsyncAllPropertiesGetter(IProxy& proxy)
            : proxy_(proxy)
    {
    }
 
    inline AsyncAllPropertiesGetter& AsyncAllPropertiesGetter::onInterface(std::string_view interfaceName)
    {
        interfaceName_ = std::move(interfaceName);
 
        return *this;
    }
 
    template <typename Function>
    PendingAsyncCall AsyncAllPropertiesGetter::uponReplyInvoke(Function&& callback)
    {
        static_assert( std::is_invocable_r_v<void, Function, std::optional<Error>, std::map<PropertyName, Variant>>
                     , "All properties get callback function must accept std::optional<Error> and a map of property names to their values" );
 
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("GetAll")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_)
                     .uponReplyInvoke(std::forward<Function>(callback));
    }
 
    template <typename Function>
    [[nodiscard]] Slot AsyncAllPropertiesGetter::uponReplyInvoke(Function&& callback, return_slot_t)
    {
        static_assert( std::is_invocable_r_v<void, Function, std::optional<Error>, std::map<PropertyName, Variant>>
                     , "All properties get callback function must accept std::optional<Error> and a map of property names to their values" );
 
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("GetAll")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_)
                     .uponReplyInvoke(std::forward<Function>(callback), return_slot);
    }
 
    inline std::future<std::map<PropertyName, Variant>> AsyncAllPropertiesGetter::getResultAsFuture()
    {
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("GetAll")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_)
                     .getResultAsFuture<std::map<PropertyName, Variant>>();
    }
 
    inline Awaitable<std::map<PropertyName, Variant>> AsyncAllPropertiesGetter::getResultAsAwaitable()
    {
        assert(!interfaceName_.empty()); // onInterface() must be placed/called prior to this function
 
        return proxy_.callMethodAsync("GetAll")
                     .onInterface(DBUS_PROPERTIES_INTERFACE_NAME)
                     .withArguments(interfaceName_)
                     .getResultAsAwaitable<std::map<PropertyName, Variant>>();
    }
 
} // namespace sdbus
 
#endif /* SDBUS_CPP_CONVENIENCEAPICLASSES_INL_ */