FuseMessageContent Class Reference
[FireVision FUSE Network Protocol]

FUSE message content. More...

#include <fvutils/net/fuse_message_content.h>

Inheritance diagram for FuseMessageContent:

Inheritance graph
[legend]

List of all members.


Public Member Functions

 FuseMessageContent ()
 Constructor.
virtual ~FuseMessageContent ()
 Virtual empty destructor.
virtual void serialize ()=0
 Serialize message content.
virtual void * payload () const
 Return pointer to payload.
virtual size_t payload_size () const
 Return payload size.
void free_payload ()
 Free message payload.

Protected Member Functions

void copy_payload (size_t offset, void *buf, size_t len)
 Copy payload into payload buffer to a specified offset.

Protected Attributes

void * _payload
 Pointer to payload.
size_t _payload_size
 Payloda size.

Detailed Description

FUSE message content.

Interface for complex FUSE 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 29 of file fuse_message_content.h.

Constructor & Destructor Documentation

FuseMessageContent::FuseMessageContent (  ) 

Constructor.

Definition at line 53 of file fuse_message_content.cpp.

References _payload, and _payload_size.

FuseMessageContent::~FuseMessageContent (  )  [virtual]

Virtual empty destructor.

Definition at line 61 of file fuse_message_content.cpp.

Member Function Documentation

void FuseMessageContent::copy_payload ( size_t  offset,
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:
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 104 of file fuse_message_content.cpp.

References _payload.

Referenced by FuseLutListContent::serialize(), and FuseImageListContent::serialize().

void FuseMessageContent::free_payload (  ) 

Free message payload.

Definition at line 113 of file fuse_message_content.cpp.

References _payload, and _payload_size.

Referenced by FuseNetworkMessage::~FuseNetworkMessage().

void * FuseMessageContent::payload (  )  const [virtual]

Return pointer to payload.

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

Definition at line 72 of file fuse_message_content.cpp.

References _payload, and _payload_size.

Referenced by FuseNetworkMessage::pack().

size_t FuseMessageContent::payload_size (  )  const [virtual]

Return payload size.

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

Definition at line 88 of file fuse_message_content.cpp.

References _payload, and _payload_size.

Referenced by FuseNetworkMessage::pack().

void FuseMessageContent::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 FuseImageContent, FuseImageListContent, FuseLutContent, and FuseLutListContent.

Referenced by FuseNetworkMessage::pack().

Member Data Documentation

void* FuseMessageContent::_payload [protected]

Pointer to payload.

Definition at line 46 of file fuse_message_content.h.

Referenced by copy_payload(), free_payload(), FuseImageContent::FuseImageContent(), FuseImageListContent::FuseImageListContent(), FuseLutContent::FuseLutContent(), FuseLutListContent::FuseLutListContent(), FuseMessageContent(), payload(), payload_size(), FuseLutListContent::serialize(), and FuseImageListContent::serialize().

size_t FuseMessageContent::_payload_size [protected]

Payloda size.

Definition at line 48 of file fuse_message_content.h.

Referenced by free_payload(), FuseImageContent::FuseImageContent(), FuseImageListContent::FuseImageListContent(), FuseLutContent::FuseLutContent(), FuseLutListContent::FuseLutListContent(), FuseMessageContent(), payload(), payload_size(), FuseLutListContent::serialize(), and FuseImageListContent::serialize().

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