CMessageHeader Class Reference

Message header. More...

#include <protocol.h>

Public Types
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]

Static Public Attributes
static constexpr size_t	MESSAGE_START_SIZE = 4
static constexpr size_t	COMMAND_SIZE = 12
static constexpr size_t	MESSAGE_SIZE_SIZE = 4
static constexpr size_t	CHECKSUM_SIZE = 4
static constexpr size_t	MESSAGE_SIZE_OFFSET = MESSAGE_START_SIZE + COMMAND_SIZE
static constexpr size_t	CHECKSUM_OFFSET = MESSAGE_SIZE_OFFSET + MESSAGE_SIZE_SIZE
static constexpr size_t	HEADER_SIZE = MESSAGE_START_SIZE + COMMAND_SIZE + MESSAGE_SIZE_SIZE + CHECKSUM_SIZE

Detailed Description

Message header.

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

Definition at line 28 of file protocol.h.

Member Typedef Documentation

MessageStartChars

typedef unsigned char CMessageHeader::MessageStartChars[MESSAGE_START_SIZE]

Definition at line 38 of file protocol.h.

Constructor & Destructor Documentation

CMessageHeader() [1/2]

CMessageHeader::CMessageHeader ( const MessageStartChars &  pchMessageStartIn )

explicit

Definition at line 79 of file protocol.cpp.

Here is the call graph for this function:

CMessageHeader() [2/2]

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

Definition at line 87 of file protocol.cpp.

Here is the call graph for this function:

Member Function Documentation

GetCommand()

std::string CMessageHeader::GetCommand

(

)

const

Definition at line 96 of file protocol.cpp.

Here is the call graph for this function:

IsValid()

bool CMessageHeader::IsValid

(

const MessageStartChars &

messageStart

)

const

Definition at line 101 of file protocol.cpp.

SerializationOp()

template<typename Stream , typename Operation >

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

inline

Definition at line 49 of file protocol.h.

Member Data Documentation

ADD_SERIALIZE_METHODS

CMessageHeader::ADD_SERIALIZE_METHODS

Definition at line 46 of file protocol.h.

CHECKSUM_OFFSET

constexpr size_t CMessageHeader::CHECKSUM_OFFSET = MESSAGE_SIZE_OFFSET + MESSAGE_SIZE_SIZE

static

Definition at line 36 of file protocol.h.

CHECKSUM_SIZE

constexpr size_t CMessageHeader::CHECKSUM_SIZE = 4

static

Definition at line 34 of file protocol.h.

COMMAND_SIZE

constexpr size_t CMessageHeader::COMMAND_SIZE = 12

static

Definition at line 32 of file protocol.h.

HEADER_SIZE

constexpr size_t CMessageHeader::HEADER_SIZE = MESSAGE_START_SIZE + COMMAND_SIZE + MESSAGE_SIZE_SIZE + CHECKSUM_SIZE

static

Definition at line 37 of file protocol.h.

MESSAGE_SIZE_OFFSET

constexpr size_t CMessageHeader::MESSAGE_SIZE_OFFSET = MESSAGE_START_SIZE + COMMAND_SIZE

static

Definition at line 35 of file protocol.h.

MESSAGE_SIZE_SIZE

constexpr size_t CMessageHeader::MESSAGE_SIZE_SIZE = 4

static

Definition at line 33 of file protocol.h.

MESSAGE_START_SIZE

constexpr size_t CMessageHeader::MESSAGE_START_SIZE = 4

static

Definition at line 31 of file protocol.h.

nMessageSize

uint32_t CMessageHeader::nMessageSize

Definition at line 59 of file protocol.h.

pchChecksum

uint8_t CMessageHeader::pchChecksum[CHECKSUM_SIZE]

Definition at line 60 of file protocol.h.

pchCommand

char CMessageHeader::pchCommand[COMMAND_SIZE]

Definition at line 58 of file protocol.h.

pchMessageStart

char CMessageHeader::pchMessageStart[MESSAGE_START_SIZE]

Definition at line 57 of file protocol.h.

---

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

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