dbusconnection.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 "dbuscallbacks.h"
#include "dbusdispatcher.h"
#include "dbuserror.h"
#include "dbusmessage.h"
 
#include <dbus/dbus.h>
#include <event2/event.h>
#include <memory>
#include <string>
#include <unordered_map>
 
namespace flightgear::swift {
 
class CDBusObject;

class CDBusConnection : public IDispatchable
{
public:
    enum BusType { SessionBus };

    using DisconnectedCallback = std::function<void()>;

    CDBusConnection();

    explicit CDBusConnection(DBusConnection* connection);

    ~CDBusConnection() override;
 
    // The ones below are not implemented yet.
    // If you need them, make sure that connection reference count is correct
    CDBusConnection(const CDBusConnection&) = delete;
    CDBusConnection& operator=(const CDBusConnection&) = delete;

    bool connect(BusType type);

    void setDispatcher(CDBusDispatcher* dispatcher);

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

    bool isConnected() const;

    void registerDisconnectedCallback(CDBusObject* obj, DisconnectedCallback func);

    void unregisterDisconnectedCallback(CDBusObject* obj);

    void registerObjectPath(CDBusObject* object, const std::string& interfaceName, const std::string& objectPath, const DBusObjectPathVTable& dbusObjectPathVTable);

    void sendMessage(const CDBusMessage& message);

    void close();

    CDBusError lastError() const { return m_lastError; }
 
protected:
    // cppcheck-suppress virtualCallInConstructor
    void dispatch() override;
 
private:
    void setDispatchStatus(DBusConnection* connection, DBusDispatchStatus status);
    static void setDispatchStatus(DBusConnection* connection, DBusDispatchStatus status, void* data);
    static DBusHandlerResult filterDisconnectedFunction(DBusConnection* connection, DBusMessage* message, void* data);
 
    struct DBusConnectionDeleter {
        void operator()(DBusConnection* obj) const { dbus_connection_unref(obj); }
    };
 
    CDBusDispatcher* m_dispatcher = nullptr;
    std::unique_ptr<DBusConnection, DBusConnectionDeleter> m_connection;
    CDBusError m_lastError;
    std::unordered_map<CDBusObject*, DisconnectedCallback> m_disconnectedCallbacks;
};
 
} // namespace flightgear::swift