Fawkes API
Fawkes Development Version
|
#include <>>
Public Member Functions | |
FawkesNetworkMessageContent () | |
Constructor. More... | |
virtual | ~FawkesNetworkMessageContent () |
Virtual empty destructor. More... | |
virtual void | serialize ()=0 |
virtual void * | payload () |
Return pointer to payload. More... | |
virtual size_t | payload_size () |
Return payload size. More... | |
Protected Member Functions | |
void | copy_payload (size_t offset, const void *buf, size_t len) |
Copy payload into payload buffer to a specified offset. More... | |
Protected Attributes | |
void * | _payload |
Pointer to payload. More... | |
size_t | _payload_size |
Payloda size. More... | |
Fawkes network message content. Interface for complex Fawkes network messages. Use this type if you want either a nicer interface to your network message or if you need a more complex kind of message type, for example by using DynamicBuffer.
Implement all accessor methods that you need and add any data you want. In the end you have to implement serialize() to create a single contiguous buffer that contains all the data that has to be sent. Make _payload point to this buffer and _payload_size contain the size of the buffer.
Definition at line 37 of file message_content.h.
fawkes::FawkesNetworkMessageContent::FawkesNetworkMessageContent | ( | ) |
Constructor.
Definition at line 57 of file message_content.cpp.
|
virtual |
Virtual empty destructor.
Definition at line 64 of file message_content.cpp.
References _payload, and _payload_size.
|
protected |
Copy payload into payload buffer to a specified offset.
This assumes that you have made sure that the buffer is big enough!
offset | offset in _payload where to copy the data to |
buf | buffer to copy from |
len | number of bytes to copy from buf |
Definition at line 103 of file message_content.cpp.
Referenced by fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent().
|
virtual |
Return pointer to payload.
NullPointerException | thrown if _payload does not point to a valid buffer or if _payload_size is zero. |
Definition at line 74 of file message_content.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::BlackBoardInterfaceListContent(), fawkes::ConfigListContent::ConfigListContent(), fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent(), fawkes::PluginListMessage::PluginListMessage(), and fawkes::StringContent::StringContent().
|
virtual |
Return payload size.
NullPointerException | thrown if _payload does not point to a valid buffer or if _payload_size is zero. |
Definition at line 88 of file message_content.cpp.
Referenced by fawkes::BlackBoardInterfaceListContent::BlackBoardInterfaceListContent(), fawkes::ConfigListContent::ConfigListContent(), fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent(), fawkes::PluginListMessage::PluginListMessage(), and fawkes::StringContent::StringContent().
|
pure virtual |
Serialize message content. Generate a single contiguous buffer. Make _payload point to this buffer and _payload_size contain the size of the buffer.
Implemented in fawkes::NetworkLoggerMessageContent, fawkes::BlackBoardInterfaceListContent, fawkes::StringContent, fawkes::ConfigListContent, and fawkes::PluginListMessage.
Referenced by fawkes::FawkesNetworkMessage::set_content().
|
protected |
Pointer to payload.
Definition at line 57 of file message_content.h.
Referenced by fawkes::PluginListMessage::append(), fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent(), fawkes::StringContent::StringContent(), and ~FawkesNetworkMessageContent().
|
protected |
Payloda size.
Definition at line 59 of file message_content.h.
Referenced by fawkes::PluginListMessage::append(), fawkes::StringContent::get_string(), fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent(), fawkes::StringContent::StringContent(), and ~FawkesNetworkMessageContent().