Fawkes API  Fawkes Development Version
fawkes::FawkesNetworkMessage Class Reference

Representation of a message that is sent over the network. More...

#include <netcomm/fawkes/message.h>

Inheritance diagram for fawkes::FawkesNetworkMessage:

Public Member Functions

 FawkesNetworkMessage (unsigned int clid, fawkes_message_t &msg)
 Constructor to set message and client ID. More...
 
 FawkesNetworkMessage (fawkes_message_t &msg)
 Constructor that only sets message. More...
 
 FawkesNetworkMessage (unsigned int clid, unsigned short int cid, unsigned short int msg_id, void *payload, size_t payload_size)
 Constructor to set single fields and client ID. More...
 
 FawkesNetworkMessage (unsigned int clid, unsigned short int cid, unsigned short int msg_id)
 Constructor to set single fields and client ID without payload. More...
 
 FawkesNetworkMessage (unsigned short int cid, unsigned short int msg_id, void *payload, size_t payload_size)
 Constructor to set single fields. More...
 
 FawkesNetworkMessage (unsigned int clid, unsigned short int cid, unsigned short int msg_id, FawkesNetworkMessageContent *content)
 Constructor to set single fields and client ID. More...
 
 FawkesNetworkMessage (unsigned short int cid, unsigned short int msg_id, FawkesNetworkMessageContent *content)
 Constructor to set single fields. More...
 
 FawkesNetworkMessage (unsigned short int cid, unsigned short int msg_id, size_t payload_size)
 Constructor to set single fields and allocate memory. More...
 
 FawkesNetworkMessage (unsigned short int cid, unsigned short int msg_id)
 Constructor to set single fields without payload. More...
 
 FawkesNetworkMessage ()
 Constructor. More...
 
virtual ~FawkesNetworkMessage ()
 Destructor. More...
 
unsigned int clid () const
 Get client ID. More...
 
unsigned short int cid () const
 Get component ID. More...
 
unsigned short int msgid () const
 Get message type ID. More...
 
size_t payload_size () const
 Get payload size. More...
 
void * payload () const
 Get payload buffer. More...
 
const fawkes_message_tfmsg () const
 Get message reference. More...
 
template<typename MT >
MT * msg () const
 Get correctly casted payload. More...
 
template<typename MT >
MT * msgge () const
 Get correctly casted payload. More...
 
template<typename MT >
MT * msgc () const
 Get correctly parsed output. More...
 
void set_client_id (unsigned int clid)
 Set client ID. More...
 
void set_component_id (unsigned short int cid)
 Set component ID. More...
 
void set_message_id (unsigned short int msg_id)
 Set message type ID. More...
 
void set_payload (void *payload, size_t payload_size)
 Set payload. More...
 
void set (fawkes_message_t &msg)
 Set from message. More...
 
void set_content (FawkesNetworkMessageContent *content)
 Set complex message content. More...
 
void pack ()
 Pack data for sending. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Detailed Description

Representation of a message that is sent over the network.

For the basic format of a message see fawkes_message_t. This class provides access to all of the fields in a convenient manner. Additionally it can handle the client ID, which is either the sender or the recipient of a message (depending if it's in an inbound or outbound queue).

Note that the message takes over ownership of the payload. This means that it is internally held and freed (using free()) if the message is deleted (if the reference count reaches zero). Because of this you can NOT supply a local variable. The following code is illegal:

unsigned int u = 0;

Rather you have to use the following code:

unsigned int *u = (unsigned int *)malloc(sizeof(unsigned int));
*u = 0;
FawkesNetworkMessage *m = new FawkesNetworkMessage(clid, cid, msgid, u, sizeof(unsigned int));
Author
Tim Niemueller

Definition at line 75 of file message.h.

Constructor & Destructor Documentation

◆ FawkesNetworkMessage() [1/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( unsigned int  clid,
fawkes_message_t msg 
)

Constructor to set message and client ID.

Parameters
clidclient ID
msgreference to message, deep-copied into local message.

Definition at line 99 of file message.cpp.

◆ FawkesNetworkMessage() [2/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( fawkes_message_t msg)

Constructor that only sets message.

The client ID is zero.

Parameters
msgreference to message, deep-copied into local message.

Definition at line 111 of file message.cpp.

◆ FawkesNetworkMessage() [3/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( unsigned int  clid,
unsigned short int  cid,
unsigned short int  msg_id,
void *  payload,
size_t  payload_size 
)

Constructor to set single fields and client ID.

Parameters
clidclient ID
cidcomponent ID
msg_idmessage type ID
payloadpointer to payload buffer
payload_sizesize of payload buffer

Definition at line 226 of file message.cpp.

References fawkes::FawkesNetworkMessageTooBigException::FawkesNetworkMessageTooBigException().

◆ FawkesNetworkMessage() [4/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( unsigned int  clid,
unsigned short int  cid,
unsigned short int  msg_id 
)

Constructor to set single fields and client ID without payload.

Parameters
clidclient ID
cidcomponent ID
msg_idmessage type ID

Definition at line 248 of file message.cpp.

◆ FawkesNetworkMessage() [5/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( unsigned short int  cid,
unsigned short int  msg_id,
void *  payload,
size_t  payload_size 
)

Constructor to set single fields.

The client ID is set to zero.

Parameters
cidcomponent ID
msg_idmessage type ID
payloadpointer to payload buffer
payload_sizesize of payload buffer

Definition at line 126 of file message.cpp.

References fawkes::FawkesNetworkMessageTooBigException::FawkesNetworkMessageTooBigException().

◆ FawkesNetworkMessage() [6/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( unsigned int  clid,
unsigned short int  cid,
unsigned short int  msg_id,
FawkesNetworkMessageContent content 
)

Constructor to set single fields and client ID.

Parameters
clidclient ID
cidcomponent ID
msg_idmessage type ID
contentcomplex content object

Definition at line 205 of file message.cpp.

◆ FawkesNetworkMessage() [7/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( unsigned short int  cid,
unsigned short int  msg_id,
FawkesNetworkMessageContent content 
)

Constructor to set single fields.

The client ID is set to zero.

Parameters
cidcomponent ID
msg_idmessage type ID
contentcomplex content object

Definition at line 187 of file message.cpp.

◆ FawkesNetworkMessage() [8/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( unsigned short int  cid,
unsigned short int  msg_id,
size_t  payload_size 
)

Constructor to set single fields and allocate memory.

The client ID is set to zero. The payload memory is allocated on the heap.

Parameters
cidcomponent ID
msg_idmessage type ID
payload_sizesize of payload buffer

Definition at line 149 of file message.cpp.

References fawkes::FawkesNetworkMessageTooBigException::FawkesNetworkMessageTooBigException().

◆ FawkesNetworkMessage() [9/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( unsigned short int  cid,
unsigned short int  msg_id 
)

Constructor to set single fields without payload.

The client ID is set to zero.

Parameters
cidcomponent ID
msg_idmessage type ID

Definition at line 170 of file message.cpp.

◆ FawkesNetworkMessage() [10/10]

fawkes::FawkesNetworkMessage::FawkesNetworkMessage ( )

Constructor.

Plain constructor. All values initialized to zero, including the client ID.

Definition at line 87 of file message.cpp.

◆ ~FawkesNetworkMessage()

fawkes::FawkesNetworkMessage::~FawkesNetworkMessage ( )
virtual

Destructor.

This destructor also frees the payload buffer if set!

Definition at line 263 of file message.cpp.

Member Function Documentation

◆ cid()

◆ clid()

◆ fmsg()

const fawkes_message_t & fawkes::FawkesNetworkMessage::fmsg ( ) const

Get message reference.

Returns
reference to internal fawkes_message_t, use with care!

Definition at line 331 of file message.cpp.

Referenced by fawkes::FawkesNetworkTransceiver::send().

◆ msg()

template<typename MT >
MT* fawkes::FawkesNetworkMessage::msg ( ) const
inline

Get correctly casted payload.

Use this method to cast the payload to a specific type. The size is check as a sanity check and a TypeMismatchException is thrown if the size does not match.

Returns
casted message
Exceptions
TypeMismatchExceptionpayload size does not match requested type

Definition at line 115 of file message.h.

Referenced by fawkes::BlackBoardNetworkHandler::loop(), fawkes::ConfigNetworkHandler::loop(), fawkes::NetworkConfiguration::set_default_comment(), and fawkes::RemoteBlackBoard::try_aliveness_restore().

◆ msgc()

template<typename MT >
MT* fawkes::FawkesNetworkMessage::msgc ( ) const
inline

Get correctly parsed output.

Use this method to cast the payload to a specific complex type. You can use this routine to parse complex messages that are derived from FawkesNetworkMessageContent. Note that the class must provide a constructor that takes four parameters: The component ID, message ID, a pointer to the payload and the payload size. From this the class shall parse the output and throw an exception if that for whatever reason fails.

Returns
casted message
Exceptions
TypeMismatchExceptionpayload size does not match requested type

Definition at line 154 of file message.h.

References fawkes::Exception::Exception().

Referenced by fawkes::LogView::append_message(), PluginTool::handle_signal(), fawkes::RemoteBlackBoard::list(), fawkes::RemoteBlackBoard::list_all(), and fawkes::PluginTreeView::set_gconf_prefix().

◆ msgge()

template<typename MT >
MT* fawkes::FawkesNetworkMessage::msgge ( ) const
inline

Get correctly casted payload.

Use this method to cast the payload to a specific type. The size is check as a sanity check and a TypeMismatchException is thrown if the size does not match. The size of the received message must be greater or equal to the size of the message type. Useful if message contains a variable length string.

Returns
casted message
Exceptions
TypeMismatchExceptionpayload size does not match requested type

Definition at line 134 of file message.h.

Referenced by fawkes::NetworkConfiguration::get_value().

◆ msgid()

◆ pack()

void fawkes::FawkesNetworkMessage::pack ( )

Pack data for sending.

If complex message sending is required (message content object has been set) then serialize() is called for the content and the message is prepared for sending.

Definition at line 409 of file message.cpp.

Referenced by fawkes::FawkesNetworkTransceiver::send().

◆ payload()

◆ payload_size()

◆ set()

void fawkes::FawkesNetworkMessage::set ( fawkes_message_t msg)

Set from message.

Parameters
msgreference to message. Content is deep-copied.

Definition at line 387 of file message.cpp.

◆ set_client_id()

void fawkes::FawkesNetworkMessage::set_client_id ( unsigned int  clid)

Set client ID.

Parameters
clidclient ID

Definition at line 341 of file message.cpp.

Referenced by fawkes::FawkesNetworkServerClientThread::set_clid().

◆ set_component_id()

void fawkes::FawkesNetworkMessage::set_component_id ( unsigned short int  cid)

Set component ID.

Parameters
cidcomponent ID

Definition at line 351 of file message.cpp.

◆ set_content()

void fawkes::FawkesNetworkMessage::set_content ( FawkesNetworkMessageContent content)

Set complex message content.

Parameters
contentcomplex message content.

Definition at line 397 of file message.cpp.

◆ set_message_id()

void fawkes::FawkesNetworkMessage::set_message_id ( unsigned short int  msg_id)

Set message type ID.

Parameters
msg_idmessage type ID

Definition at line 361 of file message.cpp.

◆ set_payload()

void fawkes::FawkesNetworkMessage::set_payload ( void *  payload,
size_t  payload_size 
)

Set payload.

Parameters
payloadpointer to payload buffer
payload_sizesize of payload buffer

Definition at line 372 of file message.cpp.

References fawkes::FawkesNetworkMessageTooBigException::FawkesNetworkMessageTooBigException().


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