FlightGear next
flightgear::swift::CDBusMessage Class Reference

DBus Message. More...

#include <dbusmessage.h>

Public Member Functions

 ~CDBusMessage ()
 Destructor.
 
CDBusMessageoperator= (CDBusMessage other)
 Assignment operator.
 
bool isMethodCall () const
 Is this message a method call?
 
bool wantsReply () const
 Does this message want a reply?
 
std::string getSender () const
 Get the message sender.
 
dbus_uint32_t getSerial () const
 Get the message serial. This is usally required for reply message.
 
std::string getInterfaceName () const
 Get the called interface name.
 
std::string getObjectPath () const
 Get the called object path.
 
std::string getMethodName () const
 Get the called method name.
 
void beginArgumentWrite ()
 Begin writing argument.
 
void beginArgumentRead ()
 Begin reading arguments.
 
 CDBusMessage (DBusMessage *message)
 Constructor.
 
 CDBusMessage (const CDBusMessage &other)
 
void appendArgument (bool value)
 Append argument.
 
void appendArgument (const char *value)
 
void appendArgument (const std::string &value)
 
void appendArgument (int value)
 
void appendArgument (double value)
 
void appendArgument (const std::vector< double > &array)
 
void appendArgument (const std::vector< std::string > &array)
 
void getArgument (int &value)
 Read single argument.
 
void getArgument (bool &value)
 
void getArgument (double &value)
 
void getArgument (std::string &value)
 
void getArgument (std::vector< int > &value)
 
void getArgument (std::vector< bool > &value)
 
void getArgument (std::vector< double > &value)
 
void getArgument (std::vector< std::string > &value)
 

Static Public Member Functions

static CDBusMessage createSignal (const std::string &path, const std::string &interfaceName, const std::string &signalName)
 Creates a DBus message containing a DBus signal.
 
static CDBusMessage createReply (const std::string &destination, dbus_uint32_t serial)
 Creates a DBus message containing a DBus reply.
 

Friends

class CDBusConnection
 

Detailed Description

DBus Message.

Definition at line 16 of file dbusmessage.h.

Constructor & Destructor Documentation

◆ CDBusMessage() [1/2]

flightgear::swift::CDBusMessage::CDBusMessage ( DBusMessage * message)

Constructor.

Definition at line 11 of file dbusmessage.cpp.

◆ CDBusMessage() [2/2]

flightgear::swift::CDBusMessage::CDBusMessage ( const CDBusMessage & other)

Definition at line 16 of file dbusmessage.cpp.

◆ ~CDBusMessage()

flightgear::swift::CDBusMessage::~CDBusMessage ( )

Destructor.

Definition at line 28 of file dbusmessage.cpp.

Member Function Documentation

◆ appendArgument() [1/7]

void flightgear::swift::CDBusMessage::appendArgument ( bool value)

Append argument.

Make sure to call

See also
beginArgumentWrite() before.

Definition at line 81 of file dbusmessage.cpp.

◆ appendArgument() [2/7]

void flightgear::swift::CDBusMessage::appendArgument ( const char * value)

Definition at line 87 of file dbusmessage.cpp.

◆ appendArgument() [3/7]

void flightgear::swift::CDBusMessage::appendArgument ( const std::string & value)

Definition at line 92 of file dbusmessage.cpp.

◆ appendArgument() [4/7]

void flightgear::swift::CDBusMessage::appendArgument ( const std::vector< double > & array)

Definition at line 109 of file dbusmessage.cpp.

◆ appendArgument() [5/7]

void flightgear::swift::CDBusMessage::appendArgument ( const std::vector< std::string > & array)

Definition at line 118 of file dbusmessage.cpp.

◆ appendArgument() [6/7]

void flightgear::swift::CDBusMessage::appendArgument ( double value)

Definition at line 104 of file dbusmessage.cpp.

◆ appendArgument() [7/7]

void flightgear::swift::CDBusMessage::appendArgument ( int value)

Definition at line 98 of file dbusmessage.cpp.

◆ beginArgumentRead()

void flightgear::swift::CDBusMessage::beginArgumentRead ( )

Begin reading arguments.

Definition at line 129 of file dbusmessage.cpp.

◆ beginArgumentWrite()

void flightgear::swift::CDBusMessage::beginArgumentWrite ( )

Begin writing argument.

Definition at line 76 of file dbusmessage.cpp.

◆ createReply()

CDBusMessage flightgear::swift::CDBusMessage::createReply ( const std::string & destination,
dbus_uint32_t serial )
static

Creates a DBus message containing a DBus reply.

Definition at line 235 of file dbusmessage.cpp.

◆ createSignal()

CDBusMessage flightgear::swift::CDBusMessage::createSignal ( const std::string & path,
const std::string & interfaceName,
const std::string & signalName )
static

Creates a DBus message containing a DBus signal.

Definition at line 229 of file dbusmessage.cpp.

◆ getArgument() [1/8]

void flightgear::swift::CDBusMessage::getArgument ( bool & value)

Definition at line 143 of file dbusmessage.cpp.

◆ getArgument() [2/8]

void flightgear::swift::CDBusMessage::getArgument ( double & value)

Definition at line 156 of file dbusmessage.cpp.

◆ getArgument() [3/8]

void flightgear::swift::CDBusMessage::getArgument ( int & value)

Read single argument.

Make sure to call

See also
beginArgumentRead() before.

Definition at line 134 of file dbusmessage.cpp.

◆ getArgument() [4/8]

void flightgear::swift::CDBusMessage::getArgument ( std::string & value)

Definition at line 163 of file dbusmessage.cpp.

◆ getArgument() [5/8]

void flightgear::swift::CDBusMessage::getArgument ( std::vector< bool > & value)

Definition at line 185 of file dbusmessage.cpp.

◆ getArgument() [6/8]

void flightgear::swift::CDBusMessage::getArgument ( std::vector< double > & value)

Definition at line 203 of file dbusmessage.cpp.

◆ getArgument() [7/8]

void flightgear::swift::CDBusMessage::getArgument ( std::vector< int > & value)

Definition at line 172 of file dbusmessage.cpp.

◆ getArgument() [8/8]

void flightgear::swift::CDBusMessage::getArgument ( std::vector< std::string > & value)

Definition at line 216 of file dbusmessage.cpp.

◆ getInterfaceName()

std::string flightgear::swift::CDBusMessage::getInterfaceName ( ) const

Get the called interface name.

Definition at line 61 of file dbusmessage.cpp.

◆ getMethodName()

std::string flightgear::swift::CDBusMessage::getMethodName ( ) const

Get the called method name.

Definition at line 71 of file dbusmessage.cpp.

◆ getObjectPath()

std::string flightgear::swift::CDBusMessage::getObjectPath ( ) const

Get the called object path.

Definition at line 66 of file dbusmessage.cpp.

◆ getSender()

std::string flightgear::swift::CDBusMessage::getSender ( ) const

Get the message sender.

Definition at line 50 of file dbusmessage.cpp.

◆ getSerial()

dbus_uint32_t flightgear::swift::CDBusMessage::getSerial ( ) const

Get the message serial. This is usally required for reply message.

Definition at line 56 of file dbusmessage.cpp.

◆ isMethodCall()

bool flightgear::swift::CDBusMessage::isMethodCall ( ) const

Is this message a method call?

Definition at line 40 of file dbusmessage.cpp.

◆ operator=()

CDBusMessage & flightgear::swift::CDBusMessage::operator= ( CDBusMessage other)

Assignment operator.

Definition at line 33 of file dbusmessage.cpp.

◆ wantsReply()

bool flightgear::swift::CDBusMessage::wantsReply ( ) const

Does this message want a reply?

Definition at line 45 of file dbusmessage.cpp.

Friends And Related Symbol Documentation

◆ CDBusConnection

friend class CDBusConnection
friend

Definition at line 88 of file dbusmessage.h.


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