forked from Kistler-Group/sdbus-cpp
42f0bd07c0
This introduces strong types for `std::string`-based D-Bus types. This facilitates safer, less error-prone and more expressive API.
What previously was `auto proxy = createProxy("org.sdbuscpp.concatenator", "/org/sdbuscpp/concatenator");` is now written like `auto proxy = createProxy(ServiceName{"org.sdbuscpp.concatenator"}, ObjectPath{"/org/sdbuscpp/concatenator"});`.
These types are:
* `ObjectPath` type for the object path (the type has been around already but now is also used consistently in sdbus-c++ API for object path strings),
* `InterfaceName` type for D-Bus interface names,
* `BusName` (and its aliases `ServiceName` and `ConnectionName`) type for bus/service/connection names,
* `MemberName` (and its aliases `MethodName`, `SignalName` and `PropertyName`) type for D-Bus method, signal and property names,
* `Signature` type for the D-Bus signature (the type has been around already but now is also used consistently in sdbus-c++ API for signature strings),
* `Error::Name` type for D-Bus error names.
235 lines
10 KiB
C++
235 lines
10 KiB
C++
/**
|
|
* (C) 2016 - 2021 KISTLER INSTRUMENTE AG, Winterthur, Switzerland
|
|
* (C) 2016 - 2024 Stanislav Angelovic <stanislav.angelovic@protonmail.com>
|
|
*
|
|
* @file Connection.h
|
|
*
|
|
* Created on: Nov 8, 2016
|
|
* 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef SDBUS_CXX_INTERNAL_CONNECTION_H_
|
|
#define SDBUS_CXX_INTERNAL_CONNECTION_H_
|
|
|
|
#include "sdbus-c++/IConnection.h"
|
|
|
|
#include "sdbus-c++/Message.h"
|
|
|
|
#include "IConnection.h"
|
|
#include "ISdBus.h"
|
|
#include "ScopeGuard.h"
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
#include SDBUS_HEADER
|
|
#include <thread>
|
|
#include <vector>
|
|
|
|
// Forward declarations
|
|
struct sd_event_source;
|
|
namespace sdbus {
|
|
class ObjectPath;
|
|
class InterfaceName;
|
|
class BusName;
|
|
using ServiceName = BusName;
|
|
class MemberName;
|
|
using MethodName = MemberName;
|
|
using SignalName = MemberName;
|
|
using PropertyName = MemberName;
|
|
}
|
|
|
|
namespace sdbus::internal {
|
|
|
|
class Connection final
|
|
: public sdbus::internal::IConnection
|
|
{
|
|
public:
|
|
// Bus type tags
|
|
struct default_bus_t{};
|
|
inline static constexpr default_bus_t default_bus{};
|
|
struct system_bus_t{};
|
|
inline static constexpr system_bus_t system_bus{};
|
|
struct session_bus_t{};
|
|
inline static constexpr session_bus_t session_bus{};
|
|
struct custom_session_bus_t{};
|
|
inline static constexpr custom_session_bus_t custom_session_bus{};
|
|
struct remote_system_bus_t{};
|
|
inline static constexpr remote_system_bus_t remote_system_bus{};
|
|
struct private_bus_t{};
|
|
inline static constexpr private_bus_t private_bus{};
|
|
struct server_bus_t{};
|
|
inline static constexpr server_bus_t server_bus{};
|
|
struct sdbus_bus_t{}; // A bus connection created directly from existing sd_bus instance
|
|
inline static constexpr sdbus_bus_t sdbus_bus{};
|
|
struct pseudo_bus_t{}; // A bus connection that is not really established with D-Bus daemon
|
|
inline static constexpr pseudo_bus_t pseudo_bus{};
|
|
|
|
Connection(std::unique_ptr<ISdBus>&& interface, default_bus_t);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, system_bus_t);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, session_bus_t);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, custom_session_bus_t, const std::string& address);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, remote_system_bus_t, const std::string& host);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, private_bus_t, const std::string& address);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, private_bus_t, int fd);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, server_bus_t, int fd);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, sdbus_bus_t, sd_bus *bus);
|
|
Connection(std::unique_ptr<ISdBus>&& interface, pseudo_bus_t);
|
|
~Connection() override;
|
|
|
|
void requestName(const ServiceName & name) override;
|
|
void releaseName(const ServiceName& name) override;
|
|
[[nodiscard]] BusName getUniqueName() const override;
|
|
void enterEventLoop() override;
|
|
void enterEventLoopAsync() override;
|
|
void leaveEventLoop() override;
|
|
[[nodiscard]] PollData getEventLoopPollData() const override;
|
|
bool processPendingEvent() override;
|
|
Message getCurrentlyProcessedMessage() const override;
|
|
|
|
void addObjectManager(const ObjectPath& objectPath, floating_slot_t) override;
|
|
Slot addObjectManager(const ObjectPath& objectPath, return_slot_t) override;
|
|
|
|
void setMethodCallTimeout(uint64_t timeout) override;
|
|
[[nodiscard]] uint64_t getMethodCallTimeout() const override;
|
|
|
|
[[nodiscard]] Slot addMatch(const std::string& match, message_handler callback) override;
|
|
void addMatch(const std::string& match, message_handler callback, floating_slot_t) override;
|
|
[[nodiscard]] Slot addMatchAsync(const std::string& match, message_handler callback, message_handler installCallback) override;
|
|
void addMatchAsync(const std::string& match, message_handler callback, message_handler installCallback, floating_slot_t) override;
|
|
|
|
void attachSdEventLoop(sd_event *event, int priority) override;
|
|
void detachSdEventLoop() override;
|
|
sd_event *getSdEventLoop() override;
|
|
|
|
[[nodiscard]] const ISdBus& getSdBusInterface() const override;
|
|
[[nodiscard]] ISdBus& getSdBusInterface() override;
|
|
|
|
Slot addObjectVTable( const ObjectPath& objectPath
|
|
, const InterfaceName& interfaceName
|
|
, const sd_bus_vtable* vtable
|
|
, void* userData ) override;
|
|
|
|
[[nodiscard]] PlainMessage createPlainMessage() const override;
|
|
[[nodiscard]] MethodCall createMethodCall( const ServiceName& destination
|
|
, const ObjectPath& objectPath
|
|
, const InterfaceName& interfaceName
|
|
, const MethodName& methodName ) const override;
|
|
[[nodiscard]] Signal createSignal( const ObjectPath& objectPath
|
|
, const InterfaceName& interfaceName
|
|
, const SignalName& signalName ) const override;
|
|
|
|
MethodReply callMethod(const MethodCall& message, uint64_t timeout) override;
|
|
void callMethod(const MethodCall& message, void* callback, void* userData, uint64_t timeout, floating_slot_t) override;
|
|
Slot callMethod(const MethodCall& message, void* callback, void* userData, uint64_t timeout) override;
|
|
|
|
void emitPropertiesChangedSignal( const ObjectPath& objectPath
|
|
, const InterfaceName& interfaceName
|
|
, const std::vector<PropertyName>& propNames ) override;
|
|
void emitInterfacesAddedSignal(const ObjectPath& objectPath) override;
|
|
void emitInterfacesAddedSignal( const ObjectPath& objectPath
|
|
, const std::vector<InterfaceName>& interfaces ) override;
|
|
void emitInterfacesRemovedSignal(const ObjectPath& objectPath) override;
|
|
void emitInterfacesRemovedSignal( const ObjectPath& objectPath
|
|
, const std::vector<InterfaceName>& interfaces ) override;
|
|
|
|
Slot registerSignalHandler( const ServiceName& sender
|
|
, const ObjectPath& objectPath
|
|
, const InterfaceName& interfaceName
|
|
, const SignalName& signalName
|
|
, sd_bus_message_handler_t callback
|
|
, void* userData ) override;
|
|
|
|
private:
|
|
using BusFactory = std::function<int(sd_bus**)>;
|
|
using BusPtr = std::unique_ptr<sd_bus, std::function<sd_bus*(sd_bus*)>>;
|
|
Connection(std::unique_ptr<ISdBus>&& interface, const BusFactory& busFactory);
|
|
|
|
BusPtr openBus(const std::function<int(sd_bus**)>& busFactory);
|
|
BusPtr openPseudoBus();
|
|
void finishHandshake(sd_bus* bus);
|
|
bool waitForNextEvent();
|
|
|
|
[[nodiscard]] bool arePendingMessagesInReadQueue() const;
|
|
|
|
void notifyEventLoopToExit();
|
|
void notifyEventLoopToWakeUpFromPoll();
|
|
void wakeUpEventLoopIfMessagesInQueue();
|
|
void joinWithEventLoop();
|
|
|
|
template <typename StringBasedType>
|
|
static std::vector</*const */char*> to_strv(const std::vector<StringBasedType>& strings);
|
|
|
|
static int sdbus_match_callback(sd_bus_message *sdbusMessage, void *userData, sd_bus_error *retError);
|
|
static int sdbus_match_install_callback(sd_bus_message *sdbusMessage, void *userData, sd_bus_error *retError);
|
|
|
|
private:
|
|
#ifndef SDBUS_basu // sd_event integration is not supported if instead of libsystemd we are based on basu
|
|
Slot createSdEventSlot(sd_event *event);
|
|
Slot createSdTimeEventSourceSlot(sd_event *event, int priority);
|
|
Slot createSdIoEventSourceSlot(sd_event *event, int fd, int priority);
|
|
Slot createSdInternalEventSourceSlot(sd_event *event, int fd, int priority);
|
|
static void deleteSdEventSource(sd_event_source *s);
|
|
|
|
static int onSdTimerEvent(sd_event_source *s, uint64_t usec, void *userdata);
|
|
static int onSdIoEvent(sd_event_source *s, int fd, uint32_t revents, void *userdata);
|
|
static int onSdInternalEvent(sd_event_source *s, int fd, uint32_t revents, void *userdata);
|
|
static int onSdEventPrepare(sd_event_source *s, void *userdata);
|
|
#endif
|
|
|
|
struct EventFd
|
|
{
|
|
EventFd();
|
|
~EventFd();
|
|
void notify();
|
|
bool clear();
|
|
|
|
int fd{-1};
|
|
};
|
|
|
|
struct MatchInfo
|
|
{
|
|
message_handler callback;
|
|
message_handler installCallback;
|
|
Connection& connection;
|
|
Slot slot;
|
|
};
|
|
|
|
// sd-event integration
|
|
struct SdEvent
|
|
{
|
|
Slot sdEvent;
|
|
Slot sdTimeEventSource;
|
|
Slot sdIoEventSource;
|
|
Slot sdInternalEventSource;
|
|
};
|
|
|
|
private:
|
|
std::unique_ptr<ISdBus> sdbus_;
|
|
BusPtr bus_;
|
|
std::thread asyncLoopThread_;
|
|
EventFd loopExitFd_; // To wake up event loop I/O polling to exit
|
|
EventFd eventFd_; // To wake up event loop I/O polling to re-enter poll with fresh PollData values
|
|
std::vector<Slot> floatingMatchRules_;
|
|
std::unique_ptr<SdEvent> sdEvent_; // Integration of systemd sd-event event loop implementation
|
|
};
|
|
|
|
}
|
|
|
|
#endif /* SDBUS_CXX_INTERNAL_CONNECTION_H_ */
|