Fawkes API  Fawkes Development Version
fawkes::FawkesNetworkMessageContent Class Referenceabstract

#include <>>

Inheritance diagram for fawkes::FawkesNetworkMessageContent:

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...
 

Detailed Description

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.

See also
DynamicBuffer
Author
Tim Niemueller

Definition at line 39 of file message_content.h.

Constructor & Destructor Documentation

◆ FawkesNetworkMessageContent()

fawkes::FawkesNetworkMessageContent::FawkesNetworkMessageContent ( )

Constructor.

Definition at line 59 of file message_content.cpp.

◆ ~FawkesNetworkMessageContent()

fawkes::FawkesNetworkMessageContent::~FawkesNetworkMessageContent ( )
virtual

Virtual empty destructor.

Definition at line 66 of file message_content.cpp.

References _payload, and _payload_size.

Member Function Documentation

◆ copy_payload()

void fawkes::FawkesNetworkMessageContent::copy_payload ( size_t  offset,
const void *  buf,
size_t  len 
)
protected

Copy payload into payload buffer to a specified offset.

This assumes that you have made sure that the buffer is big enough!

Parameters
offsetoffset in _payload where to copy the data to
bufbuffer to copy from
lennumber of bytes to copy from buf

Definition at line 105 of file message_content.cpp.

Referenced by fawkes::PluginListMessage::append(), and fawkes::NetworkLoggerMessageContent::NetworkLoggerMessageContent().

◆ payload()

void * fawkes::FawkesNetworkMessageContent::payload ( )
virtual

Return pointer to payload.

Returns
pointer to payload
Exceptions
NullPointerExceptionthrown if _payload does not point to a valid buffer or if _payload_size is zero.

Definition at line 76 of file message_content.cpp.

◆ payload_size()

size_t fawkes::FawkesNetworkMessageContent::payload_size ( )
virtual

Return payload size.

Returns
payload size
Exceptions
NullPointerExceptionthrown if _payload does not point to a valid buffer or if _payload_size is zero.

Definition at line 90 of file message_content.cpp.

◆ serialize()

void fawkes::FawkesNetworkMessageContent::serialize ( )
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().

Member Data Documentation

◆ _payload

void* fawkes::FawkesNetworkMessageContent::_payload
protected

◆ _payload_size

size_t fawkes::FawkesNetworkMessageContent::_payload_size
protected

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