DBus::ErrorMessage Class Reference

Represents a DBus Error message. More...

#include <errormessage.h>

Inheritance diagram for DBus::ErrorMessage:

Public Member Functions

std::string name () const
 
void set_name (const std::string &n)
 
std::string message () const
 
void set_message (const std::string &message)
 
bool operator== (const ErrorMessage &) const
 
virtual MessageType type () const
 
bool set_reply_serial (uint32_t)
 
uint32_t reply_serial () const
 
void throw_error ()
 Throw the error associated with this ErrorMessage. More...
 
- Public Member Functions inherited from DBus::Message
virtual ~Message ()
 
bool operator== (const Message &other)
 
bool is_valid () const
 
void invalidate ()
 
 operator bool () const
 
uint32_t serial () const
 
void set_auto_start (bool auto_start)
 
bool auto_start ()
 Returns true if the bus is allowed to start an owner for this message's destination if it is not running. More...
 
bool set_destination (const std::string &s)
 Set the destination of this message. More...
 
std::string destination () const
 
std::string sender () const
 
Signature signature () const
 
template<typename T >
MessageIterator operator>> (T &value) const
 
template<typename T >
MessageAppendIterator operator<< (const T &value)
 
MessageIterator begin () const
 
MessageIterator end () const
 
MessageAppendIterator append ()
 
bool serialize_to_vector (std::vector< uint8_t > *vec, uint32_t serial) const
 Serialize this message to the given vector. More...
 
Variant header_field (MessageHeaderFields field) const
 Returns the given header field(if it exists), otherwise returns a default constructed variant. More...
 
uint8_t flags () const
 The message flags, as the marshaled byte. More...
 
Variant set_header_field (MessageHeaderFields field, Variant value)
 Set the given header field. More...
 
Endianess endianess () const
 
const std::vector< int > & filedescriptors () const
 

Static Public Member Functions

static std::shared_ptr< ErrorMessagecreate ()
 
static std::shared_ptr< ErrorMessagecreate (std::shared_ptr< const CallMessage > callMessage, const std::string &name, const std::string &message)
 
- Static Public Member Functions inherited from DBus::Message
static std::shared_ptr< Messagecreate_from_data (uint8_t *data, uint32_t data_len, std::vector< int > fds=std::vector< int >())
 

Protected Member Functions

 ErrorMessage ()
 
 ErrorMessage (std::shared_ptr< const CallMessage > callMessage, const std::string &name, const std::string &message)
 
- Protected Member Functions inherited from DBus::Message
 Message ()
 
void append_signature (std::string toappend)
 
void clear_sig_and_data ()
 Clears the signature and the data, so you can re-append data. More...
 
void set_flags (uint8_t flags)
 

Detailed Description

Represents a DBus Error message.

This class inherits from Message and uses the dbus_message_* methods to create an interface for an error message.

Author
Rick L Vinyard Jr rviny.nosp@m.ard@.nosp@m.cs.nm.nosp@m.su.e.nosp@m.du

Constructor & Destructor Documentation

◆ ErrorMessage() [1/2]

DBus::ErrorMessage::ErrorMessage ( )
protected

Referenced by create().

◆ ErrorMessage() [2/2]

DBus::ErrorMessage::ErrorMessage ( std::shared_ptr< const CallMessage callMessage,
const std::string &  name,
const std::string &  message 
)
protected

Member Function Documentation

◆ create() [1/2]

◆ create() [2/2]

std::shared_ptr< ErrorMessage > DBus::ErrorMessage::create ( std::shared_ptr< const CallMessage callMessage,
const std::string &  name,
const std::string &  message 
)
static

References ErrorMessage(), message(), and name().

◆ message()

◆ name()

◆ operator==()

bool DBus::ErrorMessage::operator== ( const ErrorMessage m) const

References message(), and name().

◆ reply_serial()

uint32_t DBus::ErrorMessage::reply_serial ( ) const

◆ set_message()

void DBus::ErrorMessage::set_message ( const std::string &  message)

◆ set_name()

void DBus::ErrorMessage::set_name ( const std::string &  n)

◆ set_reply_serial()

bool DBus::ErrorMessage::set_reply_serial ( uint32_t  s)

◆ throw_error()

◆ type()

MessageType DBus::ErrorMessage::type ( ) const
virtual

Implements DBus::Message.

References DBus::ERROR.


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