dbusobject.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: (C) 2019-2022 swift Project Community / Contributors (https://swift-project.org/)
 * SPDX-FileCopyrightText: (C) 2019-2022 Lars Toenning <dev@ltoenning.de>
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#pragma once
 
#include "dbusconnection.h"
#include <deque>
#include <mutex>
 
namespace flightgear::swift {
class CDBusObject
{
public:
    CDBusObject() = default;

    virtual ~CDBusObject();

    void setDBusConnection(const std::shared_ptr<CDBusConnection>& dbusConnection);

    void registerDBusObjectPath(const std::string& interfaceName, const std::string& objectPath);
 
protected:
    virtual void dbusConnectedHandler() {}

    virtual DBusHandlerResult dbusMessageHandler(const CDBusMessage& message) = 0;

    virtual void dbusDisconnectedHandler() {}

    void sendDBusSignal(const std::string& name);

    void sendDBusMessage(const CDBusMessage& message);

    void maybeSendEmptyDBusReply(bool wantsReply, const std::string& destination, dbus_uint32_t serial);

    template <typename T>
    void sendDBusReply(const std::string& destination, dbus_uint32_t serial, const T& argument)
    {
        CDBusMessage reply = CDBusMessage::createReply(destination, serial);
        reply.beginArgumentWrite();
        reply.appendArgument(argument);
        m_dbusConnection->sendMessage(reply);
    }

    template <typename T>
    void sendDBusReply(const std::string& destination, dbus_uint32_t serial, const std::vector<T>& array)
    {
        CDBusMessage reply = CDBusMessage::createReply(destination, serial);
        reply.beginArgumentWrite();
        reply.appendArgument(array);
        m_dbusConnection->sendMessage(reply);
    }

    void queueDBusCall(const std::function<void()>& func);

    void invokeQueuedDBusCalls();
 
private:
    static void dbusObjectPathUnregisterFunction(DBusConnection* connection, void* data);
    static DBusHandlerResult dbusObjectPathMessageFunction(DBusConnection* connection, DBusMessage* message, void* data);
 
    std::shared_ptr<CDBusConnection> m_dbusConnection;
    std::string m_interfaceName;
    std::string m_objectPath;
 
    std::mutex m_mutex;
    std::deque<std::function<void()>> m_queuedDBusCalls;
 
    const DBusObjectPathVTable m_dbusObjectPathVTable = {dbusObjectPathUnregisterFunction, dbusObjectPathMessageFunction, nullptr, nullptr, nullptr, nullptr};
};
 
} // namespace flightgear::swift