/** * (C) 2016 - 2021 KISTLER INSTRUMENTE AG, Winterthur, Switzerland * (C) 2016 - 2022 Stanislav Angelovic * * @file ProxyInterfaces.h * * Created on: Apr 8, 2019 * Project: sdbus-c++ * Description: High-level D-Bus IPC C++ library based on sd-bus * * This file is part of sdbus-c++. * * sdbus-c++ is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, either version 2.1 of the License, or * (at your option) any later version. * * sdbus-c++ is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with sdbus-c++. If not, see . */ #ifndef SDBUS_CXX_PROXYINTERFACES_H_ #define SDBUS_CXX_PROXYINTERFACES_H_ #include #include #include #include // Forward declarations namespace sdbus { class IConnection; } namespace sdbus { /********************************************//** * @class ProxyObjectHolder * * ProxyObjectHolder is a helper that simply owns and provides * access to a proxy object to other classes in the inheritance * hierarchy of a native-like proxy object based on generated * interface classes. * ***********************************************/ class ProxyObjectHolder { protected: ProxyObjectHolder(std::unique_ptr&& proxy) : proxy_(std::move(proxy)) { assert(proxy_ != nullptr); } const IProxy& getProxy() const { assert(proxy_ != nullptr); return *proxy_; } IProxy& getProxy() { assert(proxy_ != nullptr); return *proxy_; } private: std::unique_ptr proxy_; }; /********************************************//** * @class ProxyInterfaces * * ProxyInterfaces is a helper template class that joins all interface classes of a remote * D-Bus object generated by sdbus-c++-xml2cpp to be used on the client (the proxy) side, * including some auxiliary classes. ProxyInterfaces is the class that native-like proxy * implementation classes written by users should inherit from and implement all pure virtual * methods. So the _Interfaces template parameter is a list of sdbus-c++-xml2cpp-generated * proxy-side interface classes representing interfaces of the corresponding remote D-Bus object. * * In the final proxy class inherited from ProxyInterfaces, it is necessary to finish proxy * registration in class constructor (`finishRegistration();`), and, conversely, unregister * the proxy in class destructor (`unregister();`). * ***********************************************/ template class ProxyInterfaces : protected ProxyObjectHolder , public _Interfaces... { public: /*! * @brief Creates native-like proxy object instance * * @param[in] destination Bus name that provides a D-Bus object * @param[in] objectPath Path of the D-Bus object * * This constructor overload creates a proxy that manages its own D-Bus connection(s). * For more information on its behavior, consult @ref createProxy(std::string,std::string) */ ProxyInterfaces(std::string destination, std::string objectPath) : ProxyObjectHolder(createProxy(std::move(destination), std::move(objectPath))) , _Interfaces(getProxy())... { } /*! * @brief Creates native-like proxy object instance * * @param[in] destination Bus name that provides a D-Bus object * @param[in] objectPath Path of the D-Bus object * * This constructor overload creates a proxy that manages its own D-Bus connection(s). * For more information on its behavior, consult @ref createProxy(std::string,std::string,sdbus::dont_run_event_loop_thread_t) */ ProxyInterfaces(std::string destination, std::string objectPath, dont_run_event_loop_thread_t) : ProxyObjectHolder(createProxy(std::move(destination), std::move(objectPath), dont_run_event_loop_thread)) , _Interfaces(getProxy())... { } /*! * @brief Creates native-like proxy object instance * * @param[in] connection D-Bus connection to be used by the proxy object * @param[in] destination Bus name that provides a D-Bus object * @param[in] objectPath Path of the D-Bus object * * The proxy created this way just references a D-Bus connection owned and managed by the user. * For more information on its behavior, consult @ref createProxy(IConnection&,std::string,std::string) */ ProxyInterfaces(IConnection& connection, std::string destination, std::string objectPath) : ProxyObjectHolder(createProxy(connection, std::move(destination), std::move(objectPath))) , _Interfaces(getProxy())... { } /*! * @brief Creates native-like proxy object instance * * @param[in] connection D-Bus connection to be used by the proxy object * @param[in] destination Bus name that provides a D-Bus object * @param[in] objectPath Path of the D-Bus object * * The proxy created this way becomes an owner of the connection. * For more information on its behavior, consult @ref createProxy(std::unique_ptr&&,std::string,std::string) */ ProxyInterfaces(std::unique_ptr&& connection, std::string destination, std::string objectPath) : ProxyObjectHolder(createProxy(std::move(connection), std::move(destination), std::move(objectPath))) , _Interfaces(getProxy())... { } /*! * @brief Creates native-like proxy object instance * * @param[in] connection D-Bus connection to be used by the proxy object * @param[in] destination Bus name that provides a D-Bus object * @param[in] objectPath Path of the D-Bus object * * The proxy created this way becomes an owner of the connection. * For more information on its behavior, consult @ref createProxy(std::unique_ptr&&,std::string,std::string,sdbus::dont_run_event_loop_thread_t) */ ProxyInterfaces(std::unique_ptr&& connection, std::string destination, std::string objectPath, dont_run_event_loop_thread_t) : ProxyObjectHolder(createProxy(std::move(connection), std::move(destination), std::move(objectPath), dont_run_event_loop_thread)) , _Interfaces(getProxy())... { } /*! * @brief Finishes proxy registration and makes the proxy ready for use * * This function must be called in the constructor of the final proxy class that implements ProxyInterfaces. * * For more information, see underlying @ref IProxy::finishRegistration() */ void registerProxy() { getProxy().finishRegistration(); } /*! * @brief Unregisters the proxy so it no more receives signals and async call replies * * This function must be called in the destructor of the final proxy class that implements ProxyInterfaces. * * See underlying @ref IProxy::unregister() */ void unregisterProxy() { getProxy().unregister(); } /*! * @brief Returns object path of the underlying DBus object */ const std::string& getObjectPath() const { return getProxy().getObjectPath(); } protected: using base_type = ProxyInterfaces; ProxyInterfaces(const ProxyInterfaces&) = delete; ProxyInterfaces& operator=(const ProxyInterfaces&) = delete; ProxyInterfaces(ProxyInterfaces&&) = default; ProxyInterfaces& operator=(ProxyInterfaces&&) = default; ~ProxyInterfaces() = default; }; } #endif /* SDBUS_CXX_INTERFACES_H_ */