Fawkes API
Fawkes Development Version
|
#include <>>
Public Member Functions | |
PluginListMessage () | |
Constructor. More... | |
PluginListMessage (unsigned int component_id, unsigned int msg_id, void *payload, size_t payload_size) | |
Message content constructor. More... | |
virtual | ~PluginListMessage () |
Destructor. More... | |
void | append (const char *plugin_name, size_t len) |
Append plugin name. More... | |
virtual void | serialize () |
Serialize message content. More... | |
void | reset_iterator () |
Reset iterator. More... | |
bool | has_next () |
Check if more list elements are available. More... | |
char * | next () |
Get next plugin from list. More... | |
![]() | |
FawkesNetworkMessageContent () | |
Constructor. More... | |
virtual | ~FawkesNetworkMessageContent () |
Virtual empty destructor. More... | |
virtual void * | payload () |
Return pointer to payload. More... | |
virtual size_t | payload_size () |
Return payload size. More... | |
Additional Inherited Members | |
![]() | |
void | copy_payload (size_t offset, const void *buf, size_t len) |
Copy payload into payload buffer to a specified offset. More... | |
![]() | |
void * | _payload |
Pointer to payload. More... | |
size_t | _payload_size |
Payloda size. More... | |
Plugin list message.
A complex dynamic message with an arbitrary number of plugins. Uses DynamicBuffer for the internal list of plugins and thus the buffer is limited to 64 KB.
Definition at line 34 of file list_message.h.
fawkes::PluginListMessage::PluginListMessage | ( | ) |
Constructor.
Definition at line 45 of file list_message.cpp.
References fawkes::plugin_list_msg_t::plugin_list.
fawkes::PluginListMessage::PluginListMessage | ( | unsigned int | component_id, |
unsigned int | msg_id, | ||
void * | payload, | ||
size_t | payload_size | ||
) |
Message content constructor.
This constructor is meant to be used with FawkesNetworkMessage::msgc().
component_id | component ID |
msg_id | message ID |
payload | message payload |
payload_size | total payload size |
Definition at line 58 of file list_message.cpp.
References fawkes::plugin_list_msg_t::plugin_list.
|
virtual |
Destructor.
Definition at line 73 of file list_message.cpp.
References fawkes::FawkesNetworkMessageContent::_payload, and fawkes::FawkesNetworkMessageContent::_payload_size.
void fawkes::PluginListMessage::append | ( | const char * | plugin_name, |
size_t | len | ||
) |
Append plugin name.
plugin_name | plugin name |
len | length in bytes to append (can be used for example to avoid adding a file extension. |
Definition at line 90 of file list_message.cpp.
References fawkes::DynamicBuffer::append().
Referenced by fawkes::PluginNetworkHandler::~PluginNetworkHandler().
bool fawkes::PluginListMessage::has_next | ( | ) |
Check if more list elements are available.
For incoming messages only.
Definition at line 121 of file list_message.cpp.
References fawkes::DynamicBuffer::has_next().
Referenced by PluginTool::handle_signal(), and fawkes::PluginTreeView::set_gconf_prefix().
char * fawkes::PluginListMessage::next | ( | ) |
Get next plugin from list.
Definition at line 132 of file list_message.cpp.
References fawkes::DynamicBuffer::next().
Referenced by PluginTool::handle_signal(), and fawkes::PluginTreeView::set_gconf_prefix().
void fawkes::PluginListMessage::reset_iterator | ( | ) |
Reset iterator.
For incoming messages only.
Definition at line 110 of file list_message.cpp.
References fawkes::DynamicBuffer::reset_iterator().
|
virtual |
Serialize message content.
Generate a single contiguous buffer. Make _payload point to this buffer and _payload_size contain the size of the buffer.
Implements fawkes::FawkesNetworkMessageContent.
Definition at line 97 of file list_message.cpp.
References fawkes::FawkesNetworkMessageContent::_payload, fawkes::FawkesNetworkMessageContent::_payload_size, fawkes::DynamicBuffer::buffer(), fawkes::DynamicBuffer::buffer_size(), and fawkes::FawkesNetworkMessageContent::copy_payload().