FlightGear next
flightgear::swift::CDBusConnection Class Reference

DBus connection. More...

#include <dbusconnection.h>

Inherits flightgear::swift::IDispatchable.

Public Types

enum  BusType { SessionBus }
 Bus type. More...
 
using DisconnectedCallback = std::function<void()>
 Disconnect Callback.
 

Public Member Functions

 CDBusConnection ()
 Default constructor.
 
 CDBusConnection (DBusConnection *connection)
 Constructor.
 
 ~CDBusConnection () override
 Destructor.
 
 CDBusConnection (const CDBusConnection &)=delete
 
CDBusConnectionoperator= (const CDBusConnection &)=delete
 
bool connect (BusType type)
 Connect to bus.
 
void setDispatcher (CDBusDispatcher *dispatcher)
 Set dispatcher.
 
void requestName (const std::string &name)
 Request name to the bus.
 
bool isConnected () const
 Is connected?
 
void registerDisconnectedCallback (CDBusObject *obj, DisconnectedCallback func)
 Register a disconnected callback.
 
void unregisterDisconnectedCallback (CDBusObject *obj)
 Register a disconnected callback.
 
void registerObjectPath (CDBusObject *object, const std::string &interfaceName, const std::string &objectPath, const DBusObjectPathVTable &dbusObjectPathVTable)
 Register DBus object with interfaceName and objectPath.
 
void sendMessage (const CDBusMessage &message)
 Send message to bus.
 
void close ()
 Close connection.
 
CDBusError lastError () const
 Get the last error.
 
- Public Member Functions inherited from flightgear::swift::IDispatchable
 IDispatchable ()=default
 Default constructor.
 
virtual ~IDispatchable ()=default
 Default destructor.
 

Protected Member Functions

void dispatch () override
 Dispatch execution method.
 

Detailed Description

DBus connection.

Definition at line 25 of file dbusconnection.h.

Member Typedef Documentation

◆ DisconnectedCallback

Disconnect Callback.

Definition at line 32 of file dbusconnection.h.

Member Enumeration Documentation

◆ BusType

Bus type.

Enumerator
SessionBus 

Definition at line 29 of file dbusconnection.h.

Constructor & Destructor Documentation

◆ CDBusConnection() [1/3]

flightgear::swift::CDBusConnection::CDBusConnection ( )

Default constructor.

Definition at line 14 of file dbusconnection.cpp.

◆ CDBusConnection() [2/3]

flightgear::swift::CDBusConnection::CDBusConnection ( DBusConnection * connection)
explicit

Constructor.

Definition at line 19 of file dbusconnection.cpp.

◆ ~CDBusConnection()

flightgear::swift::CDBusConnection::~CDBusConnection ( )
override

Destructor.

Definition at line 28 of file dbusconnection.cpp.

◆ CDBusConnection() [3/3]

flightgear::swift::CDBusConnection::CDBusConnection ( const CDBusConnection & )
delete

Member Function Documentation

◆ close()

void flightgear::swift::CDBusConnection::close ( )

Close connection.

Definition at line 119 of file dbusconnection.cpp.

◆ connect()

bool flightgear::swift::CDBusConnection::connect ( BusType type)

Connect to bus.

Definition at line 35 of file dbusconnection.cpp.

◆ dispatch()

void flightgear::swift::CDBusConnection::dispatch ( )
overrideprotectedvirtual

Dispatch execution method.

Implements flightgear::swift::IDispatchable.

Definition at line 124 of file dbusconnection.cpp.

◆ isConnected()

bool flightgear::swift::CDBusConnection::isConnected ( ) const

Is connected?

Definition at line 87 of file dbusconnection.cpp.

◆ lastError()

CDBusError flightgear::swift::CDBusConnection::lastError ( ) const
inline

Get the last error.

Definition at line 80 of file dbusconnection.h.

◆ operator=()

CDBusConnection & flightgear::swift::CDBusConnection::operator= ( const CDBusConnection & )
delete

◆ registerDisconnectedCallback()

void flightgear::swift::CDBusConnection::registerDisconnectedCallback ( CDBusObject * obj,
DisconnectedCallback func )

Register a disconnected callback.

Definition at line 92 of file dbusconnection.cpp.

◆ registerObjectPath()

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

Register DBus object with interfaceName and objectPath.

Parameters
object
interfaceName
objectPath
dbusObjectPathVTableVirtual table handling DBus messages

Definition at line 104 of file dbusconnection.cpp.

◆ requestName()

void flightgear::swift::CDBusConnection::requestName ( const std::string & name)

Request name to the bus.

Definition at line 80 of file dbusconnection.cpp.

◆ sendMessage()

void flightgear::swift::CDBusConnection::sendMessage ( const CDBusMessage & message)

Send message to bus.

Definition at line 112 of file dbusconnection.cpp.

◆ setDispatcher()

void flightgear::swift::CDBusConnection::setDispatcher ( CDBusDispatcher * dispatcher)

Set dispatcher.

Definition at line 57 of file dbusconnection.cpp.

◆ unregisterDisconnectedCallback()

void flightgear::swift::CDBusConnection::unregisterDisconnectedCallback ( CDBusObject * obj)

Register a disconnected callback.

Definition at line 97 of file dbusconnection.cpp.


The documentation for this class was generated from the following files: