cmlabs::MessageProtocol Class Reference

Binary DataMessage protocol handler: size-prefixed serialised messages. More...

#include <NetworkProtocols.h>

Inheritance diagram for cmlabs::MessageProtocol:

Collaboration diagram for cmlabs::MessageProtocol:

Public Member Functions
	MessageProtocol ()
Public Member Functions inherited from cmlabs::NetworkProtocol
	NetworkProtocol ()

Static Public Member Functions
static bool	CheckBufferForCompatibility (const char *buffer, uint32 length)
static bool	InitialiseConversation (NetworkConnection *con)
	Perform the initial message-protocol greeting.
static bool	SendMessage (NetworkConnection *con, DataMessage *msg, uint64 receiver=0, bool packed=false)
	Serialise and send one message.
static DataMessage *	ReceiveMessage (NetworkConnection *con, uint32 timeout)
	Read one full message frame.
Static Public Member Functions inherited from cmlabs::NetworkProtocol
static bool	CheckBufferForCompatibility (const char *buffer, uint32 length)
	Sniff whether buffer looks like this protocol.
static bool	InitialiseConversation (NetworkConnection *con)
	Perform any protocol-specific initial exchange on a new connection.

Additional Inherited Members
Public Attributes inherited from cmlabs::NetworkProtocol
uint8	protocol
	PROTOCOL_* id of this handler.

Detailed Description

Binary DataMessage protocol handler: size-prefixed serialised messages.

The native CMSDK inter-node protocol. A "frame" is simply the serialised DataMessage memory image: its first uint32 is the total size, followed by the DATAMESSAGEID object id — ReceiveMessage() peeks those 8 bytes, then reads exactly size bytes and hands the buffer to a DataMessage that adopts it (zero-copy). Used by NetworkChannel::MessageConnectionRun() and the Request* classes.

Note

The size field is not byte-order converted on the wire; both peers must share the same endianness (see the file-level byte-order notes). A blocking send/receive round-trip over an established connection:

DataMessage* out = new DataMessage();
out->setString("URI", "ping");
MessageProtocol::SendMessage(con, out);              // con keeps nothing; we still own out
delete out;
DataMessage* in = MessageProtocol::ReceiveMessage(con, 3000); // we own in
if (in) { delete in; }   // use it, then delete — caller owns the reply

Definition at line 889 of file NetworkProtocols.h.

Constructor & Destructor Documentation

MessageProtocol()

cmlabs::MessageProtocol::MessageProtocol ( )

inline

Definition at line 892 of file NetworkProtocols.h.

References cmlabs::NetworkProtocol::protocol, and PROTOCOL_MESSAGE.

Member Function Documentation

CheckBufferForCompatibility()

bool cmlabs::MessageProtocol::CheckBufferForCompatibility ( const char * buffer, uint32 length )

static

Returns

true when buffer starts with the DataMessage frame signature.

Definition at line 2360 of file NetworkProtocols.cpp.

References DATAMESSAGEID, GetObjID, and PACKEDDATAMESSAGEID.

Referenced by cmlabs::NetworkChannel::ConnectionAutodetectRun().

InitialiseConversation()

bool cmlabs::MessageProtocol::InitialiseConversation ( NetworkConnection * con )

static

Perform the initial message-protocol greeting.

Parameters

con	Connection.

Returns

true on success.

Definition at line 2366 of file NetworkProtocols.cpp.

ReceiveMessage()

DataMessage * cmlabs::MessageProtocol::ReceiveMessage ( NetworkConnection * con, uint32 timeout )

static

Read one full message frame.

Parameters

con	Connection.
timeout	Max wait in ms.

Returns

New DataMessage owned by the caller, or NULL. Blocking.

Definition at line 2386 of file NetworkProtocols.cpp.

References DATAMESSAGEID, cmlabs::DataMessage::FromPacked(), GetObjID, PACKEDDATAMESSAGEID, and cmlabs::NetworkConnection::receive().

Referenced by cmlabs::NetworkChannel::MessageConnectionRun().

SendMessage()

bool cmlabs::MessageProtocol::SendMessage ( NetworkConnection * con, DataMessage * msg, uint64 receiver = 0, bool packed = false )

static

Serialise and send one message.

Parameters

con	Connection.
msg	Message (caller keeps ownership).
receiver	Destination endpoint for datagram transports (0 for TCP).
packed	send the packed wire form (DataMessage::toPacked()); ReceiveMessage() reads both.

Returns

true if fully sent.

Definition at line 2370 of file NetworkProtocols.cpp.

References cmlabs::DataMessage::data, cmlabs::DataMessage::getSize(), cmlabs::NetworkConnection::send(), and cmlabs::DataMessage::toPacked().

Referenced by cmlabs::NetworkChannel::sendMessage(), cmlabs::NetworkChannel::sendMessage(), and cmlabs::NetworkManager::sendUDPMessage().

---

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

• /home/ubuntu/c/partner/psyclone2/CMSDK/include/NetworkProtocols.h
• /home/ubuntu/c/partner/psyclone2/CMSDK/src/NetworkProtocols.cpp