dbus-cxx logo

DBus::Message Class Reference
[DBus Messages]

This class represents a basic DBus message and also serves as a base class for the specialized message types (call, return, signal, error). More...

#include <message.h>

Inheritance diagram for DBus::Message:
Inheritance graph
[legend]

List of all members.

Public Types

typedef DBusCxxPointer< Messagepointer
typedef DBusCxxPointer< const
Message
const_pointer
typedef DBusCxxWeakPointer
< Message
weak_pointer
typedef MessageIterator iterator
typedef MessageAppendIterator append_iterator

Public Member Functions

DBusCxxPointer< ReturnMessagecreate_reply () const
virtual ~Message ()
Messageoperator= (const Message &m)
bool operator== (const Message &other)
bool is_valid () const
void invalidate ()
 operator bool () const
uint32_t serial () const
int type () const
void set_auto_start (bool auto_start)
bool auto_start ()
bool set_destination (const std::string &s)
const char * destination () const
bool set_sender (const std::string &s)
const char * sender () const
bool is_call (const std::string &interface, const std::string &method) const
bool is_signal (const std::string &interface, const std::string &signal_name) const
bool is_error (const std::string &error_name) const
bool has_destination (const std::string &name) const
bool has_sender (const std::string &name) const
template<typename T >
iterator operator>> (T &value) const
template<typename T >
append_iterator operator<< (const T &value)
iterator begin () const
iterator end () const
append_iterator append ()
DBusMessage * cobj () const

Static Public Member Functions

static pointer create (MessageType type)
static pointer create (DBusMessage *cobj=NULL, CreateMethod m=CREATE_ALIAS)
static pointer create (Message::pointer other, CreateMethod m=CREATE_ALIAS)
static pointer create (Message::const_pointer other, CreateMethod m=CREATE_ALIAS)

Protected Member Functions

 Message (MessageType type)
 Message (DBusMessage *cobj=NULL, CreateMethod m=CREATE_ALIAS)
 Message (Message::pointer other, CreateMethod m=CREATE_ALIAS)
 Message (Message::const_pointer other, CreateMethod m=CREATE_ALIAS)

Protected Attributes

DBusMessage * m_cobj
bool m_valid

Friends

void init (bool)
 Initializes the dbus-cxx library.

Detailed Description

This class represents a basic DBus message and also serves as a base class for the specialized message types (call, return, signal, error).

Author:
Rick L Vinyard Jr <rvinyard@cs.nmsu.edu>

Member Typedef Documentation

typedef DBusCxxPointer<const Message> DBus::Message::const_pointer
typedef DBusCxxPointer<Message> DBus::Message::pointer
typedef DBusCxxWeakPointer<Message> DBus::Message::weak_pointer

Constructor & Destructor Documentation

DBus::Message::Message ( MessageType  type  )  [protected]

References m_cobj.

Referenced by create().

DBus::Message::Message ( DBusMessage *  cobj = NULL,
CreateMethod  m = CREATE_ALIAS 
) [protected]

References DBus::CREATE_ALIAS, m_cobj, and m_valid.

DBus::Message::Message ( Message::pointer  other,
CreateMethod  m = CREATE_ALIAS 
) [protected]

References DBus::CREATE_ALIAS, and m_cobj.

DBus::Message::Message ( Message::const_pointer  other,
CreateMethod  m = CREATE_ALIAS 
) [protected]

References DBus::CREATE_ALIAS, and m_cobj.

DBus::Message::~Message (  )  [virtual]

References m_cobj.


Member Function Documentation

Message::append_iterator DBus::Message::append (  ) 
bool DBus::Message::auto_start (  ) 

References m_cobj.

Message::iterator DBus::Message::begin (  )  const

Referenced by operator>>().

DBusMessage * DBus::Message::cobj (  )  const
Message::pointer DBus::Message::create ( Message::const_pointer  other,
CreateMethod  m = CREATE_ALIAS 
) [static]

References Message().

Message::pointer DBus::Message::create ( Message::pointer  other,
CreateMethod  m = CREATE_ALIAS 
) [static]

References Message().

Message::pointer DBus::Message::create ( DBusMessage *  cobj = NULL,
CreateMethod  m = CREATE_ALIAS 
) [static]

Reimplemented in DBus::SignalMessage.

References Message().

Message::pointer DBus::Message::create ( MessageType  type  )  [static]
ReturnMessage::pointer DBus::Message::create_reply (  )  const
const char * DBus::Message::destination (  )  const

References m_cobj.

Message::iterator DBus::Message::end (  )  const
bool DBus::Message::has_destination ( const std::string &  name  )  const

References m_cobj.

bool DBus::Message::has_sender ( const std::string &  name  )  const

References m_cobj.

void DBus::Message::invalidate (  ) 
bool DBus::Message::is_call ( const std::string &  interface,
const std::string &  method 
) const

References m_cobj.

bool DBus::Message::is_error ( const std::string &  error_name  )  const

References m_cobj.

bool DBus::Message::is_signal ( const std::string &  interface,
const std::string &  signal_name 
) const

References m_cobj.

bool DBus::Message::is_valid (  )  const
DBus::Message::operator bool (  )  const

References is_valid().

template<typename T >
append_iterator DBus::Message::operator<< ( const T &  value  )  [inline]
Message & DBus::Message::operator= ( const Message m  ) 

References m_cobj.

bool DBus::Message::operator== ( const Message other  ) 

References m_cobj.

template<typename T >
iterator DBus::Message::operator>> ( T &  value  )  const [inline]

References begin().

const char * DBus::Message::sender (  )  const

References m_cobj.

uint32_t DBus::Message::serial (  )  const

References m_cobj.

void DBus::Message::set_auto_start ( bool  auto_start  ) 

References m_cobj.

bool DBus::Message::set_destination ( const std::string &  s  ) 

References m_cobj.

bool DBus::Message::set_sender ( const std::string &  s  ) 

References m_cobj.

int DBus::Message::type (  )  const

References m_cobj, and DBus::TYPE_INVALID.

Referenced by create_reply().


Friends And Related Function Documentation

void init ( bool   )  [friend]

Initializes the dbus-cxx library.

Parameters:
threadsafe If true the library's threadsafe structures, along with the underlying dbus library will be initialized to support threadsafe operations. This makes the library threadsafe at the cost of efficiency.

Member Data Documentation

DBusMessage* DBus::Message::m_cobj [protected]

Referenced by auto_start(), DBus::CallMessage::CallMessage(), cobj(), destination(), DBus::ErrorMessage::ErrorMessage(), DBus::CallMessage::expects_reply(), has_destination(), DBus::SignalMessage::has_interface(), DBus::CallMessage::has_interface(), DBus::SignalMessage::has_member(), DBus::CallMessage::has_member(), DBus::SignalMessage::has_path(), DBus::CallMessage::has_path(), has_sender(), DBus::ReturnMessage::has_signature(), DBus::CallMessage::has_signature(), DBus::SignalMessage::interface(), DBus::CallMessage::interface(), is_call(), is_error(), is_signal(), is_valid(), DBus::SignalMessage::member(), DBus::CallMessage::member(), Message(), DBus::ErrorMessage::name(), DBus::ReturnMessage::operator=(), operator=(), DBus::SignalMessage::operator==(), operator==(), DBus::ErrorMessage::operator==(), DBus::CallMessage::operator==(), DBus::SignalMessage::path(), DBus::CallMessage::path(), DBus::SignalMessage::path_decomposed(), DBus::CallMessage::path_decomposed(), DBus::ReturnMessage::reply_serial(), sender(), serial(), set_auto_start(), set_destination(), DBus::SignalMessage::set_interface(), DBus::CallMessage::set_interface(), DBus::SignalMessage::set_member(), DBus::CallMessage::set_member(), DBus::ErrorMessage::set_name(), DBus::CallMessage::set_no_reply(), DBus::SignalMessage::set_path(), DBus::CallMessage::set_path(), DBus::ReturnMessage::set_reply_serial(), set_sender(), DBus::SignalMessage::SignalMessage(), DBus::ReturnMessage::signature(), DBus::CallMessage::signature(), type(), and ~Message().

bool DBus::Message::m_valid [protected]

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

Generated on Thu Mar 18 09:31:33 2010 for dbus-cxx by doxygen 1.6.1