CMessageHeader Class Reference

Message header. More...

#include <protocol.h>

Public Types
enum	{   MESSAGE_START_SIZE = 4, COMMAND_SIZE = 12, MESSAGE_SIZE_SIZE = 4, CHECKSUM_SIZE = 4,   MESSAGE_SIZE_OFFSET = MESSAGE_START_SIZE + COMMAND_SIZE, CHECKSUM_OFFSET = MESSAGE_SIZE_OFFSET + MESSAGE_SIZE_SIZE, HEADER_SIZE = MESSAGE_START_SIZE + COMMAND_SIZE + MESSAGE_SIZE_SIZE + CHECKSUM_SIZE }
typedef unsigned char	MessageStartChars[MESSAGE_START_SIZE]

Public Member Functions
	CMessageHeader (const MessageStartChars &pchMessageStartIn)
	CMessageHeader (const MessageStartChars &pchMessageStartIn, const char *pszCommand, unsigned int nMessageSizeIn)
std::string	GetCommand () const
bool	IsValid (const MessageStartChars &messageStart) const
template<typename Stream , typename Operation >
void	SerializationOp (Stream &s, Operation ser_action)

Public Attributes
	ADD_SERIALIZE_METHODS
char	pchMessageStart [MESSAGE_START_SIZE]
char	pchCommand [COMMAND_SIZE]
uint32_t	nMessageSize
uint8_t	pchChecksum [CHECKSUM_SIZE]

Detailed Description

Message header.

(4) message start. (12) command. (4) size. (4) checksum.

Definition at line 27 of file protocol.h.

Member Typedef Documentation

typedef unsigned char CMessageHeader::MessageStartChars[MESSAGE_START_SIZE]

Definition at line 40 of file protocol.h.

Member Enumeration Documentation

anonymous enum

Enumerator
MESSAGE_START_SIZE
COMMAND_SIZE
MESSAGE_SIZE_SIZE
CHECKSUM_SIZE
MESSAGE_SIZE_OFFSET
CHECKSUM_OFFSET
HEADER_SIZE

Definition at line 30 of file protocol.h.

Constructor & Destructor Documentation

CMessageHeader::CMessageHeader

(

const MessageStartChars &

pchMessageStartIn

)

Definition at line 77 of file protocol.cpp.

Here is the call graph for this function:

CMessageHeader::CMessageHeader	(	const MessageStartChars &	pchMessageStartIn,
		const char *	pszCommand,
		unsigned int	nMessageSizeIn
	)

Definition at line 85 of file protocol.cpp.

Here is the call graph for this function:

Member Function Documentation

std::string CMessageHeader::GetCommand

(

)

const

Definition at line 94 of file protocol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

bool CMessageHeader::IsValid

(

const MessageStartChars &

messageStart

)

const

Definition at line 99 of file protocol.cpp.

Here is the caller graph for this function:

template<typename Stream , typename Operation >

void CMessageHeader::SerializationOp ( Stream &  s, Operation  ser_action  )

inline

Definition at line 51 of file protocol.h.

Member Data Documentation

CMessageHeader::ADD_SERIALIZE_METHODS

Definition at line 48 of file protocol.h.

uint32_t CMessageHeader::nMessageSize

Definition at line 61 of file protocol.h.

uint8_t CMessageHeader::pchChecksum[CHECKSUM_SIZE]

Definition at line 62 of file protocol.h.

char CMessageHeader::pchCommand[COMMAND_SIZE]

Definition at line 60 of file protocol.h.

char CMessageHeader::pchMessageStart[MESSAGE_START_SIZE]

Definition at line 59 of file protocol.h.

---

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

• src/protocol.h
• src/protocol.cpp