Detailed Description

A class that contain generic messages, that can be sent and received from a "CClientTCPSocket" object.

A message consists of a "header" (or type), and a "body" (or content). Apart from arbitrary data, specific methods are provided for easing the serialization of MRPT's "CSerializable" objects. This class is also used for passing data to hardware interfaces (see mrpt::comms::CSerialPort)

See also: CClientTCPSocket

Definition at line 31 of file CMessage.h.

#include <mrpt/utils/CMessage.h>

Public Member Functions
void	serializeObject (const CSerializable *obj)
	A method for serializing a MRPT's object into the content. More...

void	deserializeIntoExistingObject (CSerializable *obj)
	A method that parse the data in the message into an existing object. More...

void	deserializeIntoNewObject (CSerializable::Ptr &obj)
	A method that parse the data in the message into a new object of (a priori) unknown class. More...

void	setContentFromString (const std::string &str)
	Sets the contents of the message from a string. More...

void	getContentAsString (std::string &str)
	Gets the contents of the message as a string. More...

void	setContentFromPointer (void *ptr)
	Sets the contents of the message from a "void*" (the pointer itself becomes the message) - This is intended for inter-thread comms only. More...

void *	getContentAsPointer () const
	Gets the contents of the message as a "void*" (the pointer itself is the message) - This is intended for inter-thread comms only. More...

template<class T >
void	setContentFromStruct (const T &data)
	Sets the contents of the message from an arbitary structure - This is intended for inter-thread comms only, the message will be not cross-platform. More...

template<class T >
void	getContentAsStruct (T &data) const
	Gets the contents of the message as an arbitary structure - This is intended for inter-thread comms only, the message will be not cross-platform. More...

Public Attributes
uint32_t	type
	An identifier of the message type (only the least-sig byte is typically sent) More...

std::vector< uint8_t >	content
	The contents of the message (memory is automatically handled by the std::vector object) More...

Member Function Documentation

◆ deserializeIntoExistingObject()

void CMessage::deserializeIntoExistingObject ( CSerializable * obj )

A method that parse the data in the message into an existing object.

Note that the class of the object must be known and must match the one of the serialized object. std::exception On corrupt data, unknown serialized objects, unknown serialized object version, non-matching classes,...

Definition at line 44 of file CMRPTMessage.cpp.

References content, MRPT_END, MRPT_START, and mrpt::utils::CStream::WriteBuffer().

Here is the call graph for this function:

◆ deserializeIntoNewObject()

void CMessage::deserializeIntoNewObject ( CSerializable::Ptr & obj )

A method that parse the data in the message into a new object of (a priori) unknown class.

The pointer will contain on return a copy of the reconstructed object. Deleting this object when no longer required is the responsability of the user. Note that previous contents of the pointer will be ignored (it should be nullptr). std::exception On corrupt data, unknown serialized objects, unknown serialized object version,...

Definition at line 62 of file CMRPTMessage.cpp.

References content, MRPT_END, MRPT_START, and mrpt::utils::CStream::WriteBuffer().

Here is the call graph for this function: