swift
Loading...
Searching...
No Matches
XSwiftBus::CDBusConnection Class Reference

DBus connection. More...

#include <dbusconnection.h>

Inheritance diagram for XSwiftBus::CDBusConnection:
[legend]

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 ()
 Destructor.
 CDBusConnection (const CDBusConnection &)=delete
CDBusConnection & operator= (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.
const CDBusError & lastError () const
 Get the last error.
Public Member Functions inherited from XSwiftBus::IDispatchable
 IDispatchable ()=default
 Default constructor.
virtual ~IDispatchable ()=default
 Default destructor.

Protected Member Functions

virtual void dispatch () final
 Dispatch execution method.

Detailed Description

DBus connection.

Definition at line 30 of file dbusconnection.h.

Member Typedef Documentation

◆ DisconnectedCallback

using XSwiftBus::CDBusConnection::DisconnectedCallback = std::function<void()>

Disconnect Callback.

Definition at line 40 of file dbusconnection.h.

Member Enumeration Documentation

◆ BusType

Bus type.

Definition at line 34 of file dbusconnection.h.

Constructor & Destructor Documentation

◆ CDBusConnection() [1/2]

XSwiftBus::CDBusConnection::CDBusConnection ( )

Default constructor.

Definition at line 16 of file dbusconnection.cpp.

◆ CDBusConnection() [2/2]

XSwiftBus::CDBusConnection::CDBusConnection ( DBusConnection * connection)

Constructor.

Definition at line 18 of file dbusconnection.cpp.

◆ ~CDBusConnection()

XSwiftBus::CDBusConnection::~CDBusConnection ( )

Destructor.

Definition at line 27 of file dbusconnection.cpp.

Member Function Documentation

◆ close()

void XSwiftBus::CDBusConnection::close ( )

Close connection.

Definition at line 132 of file dbusconnection.cpp.

◆ connect()

bool XSwiftBus::CDBusConnection::connect ( BusType type)

Connect to bus.

Definition at line 40 of file dbusconnection.cpp.

◆ dispatch()

void XSwiftBus::CDBusConnection::dispatch ( )
finalprotectedvirtual

Dispatch execution method.

Implements XSwiftBus::IDispatchable.

Definition at line 140 of file dbusconnection.cpp.

◆ isConnected()

bool XSwiftBus::CDBusConnection::isConnected ( ) const

Is connected?

Definition at line 88 of file dbusconnection.cpp.

◆ lastError()

const CDBusError & XSwiftBus::CDBusConnection::lastError ( ) const
inline

Get the last error.

Definition at line 89 of file dbusconnection.h.

◆ registerDisconnectedCallback()

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

Register a disconnected callback.

Definition at line 93 of file dbusconnection.cpp.

◆ registerObjectPath()

void XSwiftBus::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 108 of file dbusconnection.cpp.

◆ requestName()

void XSwiftBus::CDBusConnection::requestName ( const std::string & name)

Request name to the bus.

Definition at line 81 of file dbusconnection.cpp.

◆ sendMessage()

void XSwiftBus::CDBusConnection::sendMessage ( const CDBusMessage & message)

Send message to bus.

Definition at line 122 of file dbusconnection.cpp.

◆ setDispatcher()

void XSwiftBus::CDBusConnection::setDispatcher ( CDBusDispatcher * dispatcher)

Set dispatcher.

Definition at line 64 of file dbusconnection.cpp.

◆ unregisterDisconnectedCallback()

void XSwiftBus::CDBusConnection::unregisterDisconnectedCallback ( CDBusObject * obj)

Register a disconnected callback.

Definition at line 98 of file dbusconnection.cpp.


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