firevision::FuseNetworkMessage Class Reference
[FireVision FUSE Network ProtocolFireVision Image Processing Framework and Applications]

FUSE Network Message. More...

#include <fvutils/net/fuse_message.h>

Inheritance diagram for firevision::FuseNetworkMessage:

[legend]
List of all members.

Public Member Functions

 FuseNetworkMessage ()
 Constructor.
 FuseNetworkMessage (FUSE_message_t *msg)
 Constructor.
 FuseNetworkMessage (FUSE_message_type_t type, void *payload, size_t payload_size, bool copy_payload=false)
 Constructor.
 FuseNetworkMessage (FUSE_message_type_t type, FuseMessageContent *content)
 Content constructor.
 FuseNetworkMessage (FUSE_message_type_t type)
 Constructor without payload.
 ~FuseNetworkMessage ()
 Destructor.
uint32_t type () const
 Get message type.
size_t payload_size () const
 Get payload size.
void * payload () const
 Get pointer to payload.
const FUSE_message_tfmsg () const
 Get plain message.
template<typename MT>
MT * msg () const
 Get correctly casted payload.
template<typename MT>
MT * msg_copy () const
 Get copy of correctly casted payload.
template<typename MT>
MT * msgc () const
 Get correctly parsed output.
void pack ()
 Pack data for sending.
void set_payload (void *payload, size_t payload_size)
 Set payload.
void set (FUSE_message_t &msg)
 Set from message.

Protected Attributes

FUSE_message_t _msg
 Internal message.

Detailed Description

FUSE Network Message.

This is the basic entity for messages that are sent over the network. Either just use this message to send arbitrary payload or derive this class for more complex behavior or nice encapsulations of messages.

Author:
Tim Niemueller

Definition at line 41 of file fuse_message.h.


Constructor & Destructor Documentation

firevision::FuseNetworkMessage::FuseNetworkMessage (  ) 

Constructor.

Definition at line 50 of file fuse_message.cpp.

References _msg.

firevision::FuseNetworkMessage::FuseNetworkMessage ( FUSE_message_t msg  ) 

Constructor.

Parameters:
msg message information to copy

Definition at line 60 of file fuse_message.cpp.

References _msg, and msg().

firevision::FuseNetworkMessage::FuseNetworkMessage ( FUSE_message_type_t  type,
void *  payload,
size_t  payload_size,
bool  copy_payload = false 
)

Constructor.

Parameters:
type message type
payload payload
payload_size size of payload
copy_payload if true payload is copied, otherwise payload is referenced and ownership of payload is claimed.

Definition at line 74 of file fuse_message.cpp.

References _msg, firevision::FUSE_message_t::header, firevision::FUSE_header_t::message_type, firevision::FUSE_message_t::payload, and firevision::FUSE_header_t::payload_size.

firevision::FuseNetworkMessage::FuseNetworkMessage ( FUSE_message_type_t  type,
FuseMessageContent content 
)

Content constructor.

Construct a message with complex message content.

Parameters:
type FUSE message type
content complex message content.

Definition at line 109 of file fuse_message.cpp.

References _msg, firevision::FUSE_message_t::header, firevision::FUSE_header_t::message_type, firevision::FUSE_message_t::payload, and firevision::FUSE_header_t::payload_size.

firevision::FuseNetworkMessage::FuseNetworkMessage ( FUSE_message_type_t  type  ) 

Constructor without payload.

Constructs message without payload.

Parameters:
type FUSE message type

Definition at line 95 of file fuse_message.cpp.

References _msg, firevision::FUSE_message_t::header, firevision::FUSE_header_t::message_type, firevision::FUSE_message_t::payload, and firevision::FUSE_header_t::payload_size.

firevision::FuseNetworkMessage::~FuseNetworkMessage (  ) 

Destructor.

Definition at line 118 of file fuse_message.cpp.

References _msg, firevision::FuseMessageContent::free_payload(), and firevision::FUSE_message_t::payload.


Member Function Documentation

const FUSE_message_t & firevision::FuseNetworkMessage::fmsg (  )  const

Get plain message.

Returns:
plain message

Definition at line 165 of file fuse_message.cpp.

References _msg.

template<typename MT>
MT* firevision::FuseNetworkMessage::msg (  )  const [inline]

Get correctly casted payload.

Use this method to cast the payload to a specific type. The size is check as a sanity check and a TypeMismatchException is thrown if the size does not match.

Returns:
casted message
Exceptions:
TypeMismatchException payload size does not match requested type

Definition at line 67 of file fuse_message.h.

Referenced by FuseNetworkMessage(), firevision::FuseServerClientThread::process_getimage_message(), firevision::FuseServerClientThread::process_getimageinfo_message(), firevision::FuseServerClientThread::process_getlut_message(), firevision::FuseServerClientThread::process_greeting_message(), and set().

template<typename MT>
MT* firevision::FuseNetworkMessage::msg_copy (  )  const [inline]

Get copy of correctly casted payload.

Use this method to cast the payload to a specific type. The size is check as a sanity check and a TypeMismatchException is thrown if the size does not match.

Returns:
copy of casted message
Exceptions:
TypeMismatchException payload size does not match requested type

Definition at line 85 of file fuse_message.h.

template<typename MT>
MT* firevision::FuseNetworkMessage::msgc (  )  const [inline]

Get correctly parsed output.

Use this method to cast the payload to a specific complex type. You can use this routine to parse complex messages that are derived from FuseComplexMessageContent. Note that the class must provide a constructor that takes three parameters: The message type, a pointer to the payload and the payload size. From this the class shall parse the output and throw an exception if that for whatever reason fails.

Returns:
casted message
Exceptions:
TypeMismatchException payload size does not match requested type

Definition at line 107 of file fuse_message.h.

Referenced by firevision::FuseServerClientThread::process_setlut_message().

void firevision::FuseNetworkMessage::pack (  ) 

Pack data for sending.

Use this if any additional packing is needed before sending the data (for example if using a DynamicBuffer).

Definition at line 202 of file fuse_message.cpp.

References _msg, firevision::FUSE_message_t::header, firevision::FuseMessageContent::payload(), firevision::FUSE_message_t::payload, firevision::FuseMessageContent::payload_size(), firevision::FUSE_header_t::payload_size, and firevision::FuseMessageContent::serialize().

void * firevision::FuseNetworkMessage::payload (  )  const

Get pointer to payload.

Returns:
pointer to payload.

Definition at line 155 of file fuse_message.cpp.

References _msg, and firevision::FUSE_message_t::payload.

Referenced by firevision::FuseServerClientThread::process_getimage_message(), firevision::FuseServerClientThread::process_getimageinfo_message(), and firevision::FuseServerClientThread::process_getlut_message().

size_t firevision::FuseNetworkMessage::payload_size (  )  const

Get payload size.

Returns:
payload size

Definition at line 145 of file fuse_message.cpp.

References _msg, firevision::FUSE_message_t::header, and firevision::FUSE_header_t::payload_size.

Referenced by firevision::FuseServerClientThread::process_getimage_message(), firevision::FuseServerClientThread::process_getimageinfo_message(), and firevision::FuseServerClientThread::process_getlut_message().

void firevision::FuseNetworkMessage::set ( FUSE_message_t msg  ) 

Set from message.

Parameters:
msg reference to message. Content is deep-copied.

Definition at line 192 of file fuse_message.cpp.

References _msg, and msg().

void firevision::FuseNetworkMessage::set_payload ( void *  payload,
size_t  payload_size 
)

Set payload.

Payload is referenced and ownership claimed.

Parameters:
payload payload
payload_size size of payload

Definition at line 177 of file fuse_message.cpp.

References _msg, firevision::FUSE_message_t::header, firevision::FUSE_message_t::payload, and firevision::FUSE_header_t::payload_size.

uint32_t firevision::FuseNetworkMessage::type (  )  const

Get message type.

Returns:
message type

Definition at line 135 of file fuse_message.cpp.

References _msg, firevision::FUSE_message_t::header, and firevision::FUSE_header_t::message_type.


Member Data Documentation

FUSE_message_t firevision::FuseNetworkMessage::_msg [protected]

Internal message.

Fill in derivatives.

Definition at line 127 of file fuse_message.h.

Referenced by fmsg(), FuseNetworkMessage(), pack(), payload(), payload_size(), set(), set_payload(), type(), and ~FuseNetworkMessage().


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:31:44 2011 for Fawkes API by  doxygen 1.4.7