DBus::SignalMessage Class Reference

Represents a DBus signal message. More...

#include <signalmessage.h>

Inheritance diagram for DBus::SignalMessage:

Public Member Functions
bool	set_path (const std::string &p)
Path	path () const
std::vector< std::string >	path_decomposed () const
bool	set_interface (const std::string &i)
std::string	interface_name () const
bool	set_member (const std::string &m)
std::string	member () const
virtual MessageType	type () const
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< SignalMessage >	create ()
static std::shared_ptr< SignalMessage >	create (const std::string &name)
static std::shared_ptr< SignalMessage >	create (const std::string &path, const std::string &interface_name, const std::string &name)
Static Public Member Functions inherited from DBus::Message
static std::shared_ptr< Message >	create_from_data (uint8_t *data, uint32_t data_len, std::vector< int > fds=std::vector< int >())

Protected Member Functions
	SignalMessage ()
	SignalMessage (const std::string &name)
	SignalMessage (const std::string &path, const std::string &interface_name, const std::string &name)
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 signal message.

This class inherits from Message and uses the dbus_message_* methods to create an interface for a signal message that is received from a signal or transmitted on signal emission.

Author

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

Constructor & Destructor Documentation

SignalMessage() [1/3]

DBus::SignalMessage::SignalMessage ( )

protected

Referenced by create().

SignalMessage() [2/3]

DBus::SignalMessage::SignalMessage ( const std::string &  name )

protected

References set_member().

SignalMessage() [3/3]

DBus::SignalMessage::SignalMessage ( const std::string &  path, const std::string &  interface_name, const std::string &  name  )

protected

References interface_name(), path(), set_interface(), set_member(), and set_path().

Member Function Documentation

create() [1/3]

std::shared_ptr< SignalMessage > DBus::SignalMessage::create ( )

static

References SignalMessage().

Referenced by DBus::Message::create_from_data(), DBus::Signal< void(T_type...)>::internal_callback(), and DBus::Interface::property_updated().

create() [2/3]

std::shared_ptr< SignalMessage > DBus::SignalMessage::create ( const std::string &  name )

static

References SignalMessage().

create() [3/3]

std::shared_ptr< SignalMessage > DBus::SignalMessage::create ( const std::string &  path, const std::string &  interface_name, const std::string &  name  )

static

References interface_name(), path(), and SignalMessage().

interface_name()

std::string DBus::SignalMessage::interface_name

(

)

const

References DBus::Message::header_field(), DBus::Interface, DBus::STRING, DBus::Variant::to_string(), and DBus::Variant::type().

Referenced by create(), and SignalMessage().

member()

std::string DBus::SignalMessage::member

(

)

const

References DBus::Message::header_field(), DBus::Member, DBus::STRING, DBus::Variant::to_string(), and DBus::Variant::type().

path()

Path DBus::SignalMessage::path

(

)

const

References DBus::Message::header_field(), DBus::OBJECT_PATH, DBus::Path, DBus::Variant::to_path(), and DBus::Variant::type().

Referenced by create(), and SignalMessage().

path_decomposed()

std::vector< std::string > DBus::SignalMessage::path_decomposed

(

)

const

set_interface()

bool DBus::SignalMessage::set_interface

(

const std::string &

i

)

References DBus::Interface, DBus::Message::set_header_field(), and DBus::Validator::validate_interface_name().

Referenced by SignalMessage().

set_member()

bool DBus::SignalMessage::set_member

(

const std::string &

m

)

References DBus::Member, and DBus::Message::set_header_field().

Referenced by SignalMessage().

set_path()

bool DBus::SignalMessage::set_path

(

const std::string &

p

)

References DBus::Path, and DBus::Message::set_header_field().

Referenced by SignalMessage().

type()

MessageType DBus::SignalMessage::type ( ) const

virtual

Implements DBus::Message.

References DBus::SIGNAL.

---

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

• signalmessage.h
• signalmessage.cpp