Fawkes API
Fawkes Development Version
|
#include <>>
Public Member Functions | |
ConfigListContent () | |
Constructor. More... | |
ConfigListContent (unsigned int component_id, unsigned int msg_id, void *payload, size_t payload_size) | |
Message content constructor. More... | |
virtual | ~ConfigListContent () |
Destructor. More... | |
void | append (Configuration::ValueIterator *i) |
Append from iterator. More... | |
virtual void | serialize () |
void | reset_iterator () |
Reset iterator. More... | |
bool | has_next () |
Check if more list elements are available. More... | |
config_list_entity_header_t * | next (size_t *size) |
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... | |
Config list content. A complex dynamic message with an arbitrary number of config entities. Uses DynamicBuffer for the internal list of plugins and thus the buffer is limited to 4 GB in total.
Definition at line 41 of file net_list_content.h.
fawkes::ConfigListContent::ConfigListContent | ( | ) |
Constructor.
Definition at line 50 of file net_list_content.cpp.
fawkes::ConfigListContent::ConfigListContent | ( | 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 62 of file net_list_content.cpp.
|
virtual |
Destructor.
Definition at line 77 of file net_list_content.cpp.
void fawkes::ConfigListContent::append | ( | Configuration::ValueIterator * | i | ) |
Append from iterator.
Appends the value the iterator points to.
i | iterator |
Definition at line 103 of file net_list_content.cpp.
Referenced by fawkes::ConfigNetworkHandler::loop().
bool fawkes::ConfigListContent::has_next | ( | ) |
Check if more list elements are available.
For incoming messages only.
Definition at line 219 of file net_list_content.cpp.
References fawkes::DynamicBuffer::next().
Referenced by fawkes::NetworkConfiguration::inbound_received().
config_list_entity_header_t * fawkes::ConfigListContent::next | ( | size_t * | size | ) |
Get next plugin from list.
size | upon return contains the size of the returned data element. |
Definition at line 231 of file net_list_content.cpp.
Referenced by fawkes::NetworkConfiguration::inbound_received().
void fawkes::ConfigListContent::reset_iterator | ( | ) |
Reset iterator.
For incoming messages only.
Definition at line 209 of file net_list_content.cpp.
References fawkes::DynamicBuffer::has_next().
|
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 197 of file net_list_content.cpp.