Class CMessage
Defined in File CMessage.h
Class Documentation
-
class CMessage
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
Public Functions
-
void serializeObject(const CSerializable *obj)
A method for serializing a MRPT’s object into the content. Any modification to data in “content” after this will corrupt the object serialization. Member “type” is unmodified in this method.
-
void 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. \except std::exception On corrupt data, unknown serialized objects, unknown serialized object version, non-matching classes,…
-
void 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 responsibility of the user. Note that previous contents of the pointer will be ignored (it should be nullptr). \except std::exception On corrupt data, unknown serialized objects, unknown serialized object version,…
-
void setContentFromString(const std::string &str)
Sets the contents of the message from a string
See also
-
void getContentAsString(std::string &str)
Gets the contents of the message as a string
See also
-
template<class T>
inline 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.
See also
-
void serializeObject(const CSerializable *obj)