CMessageHeader Class Reference

Message header. More...

#include <protocol.h>

Public Types
typedef unsigned char	MessageStartChars[MESSAGE_START_SIZE]

Public Member Functions
	CMessageHeader ()=default
	CMessageHeader (const MessageStartChars &pchMessageStartIn, const char *pszCommand, unsigned int nMessageSizeIn)
	Construct a P2P message header from message-start characters, a command and the size of the message. More...
std::string	GetCommand () const
bool	IsCommandValid () const
	SERIALIZE_METHODS (CMessageHeader, obj)

Public Attributes
char	pchMessageStart [MESSAGE_START_SIZE] {}
char	pchCommand [COMMAND_SIZE] {}
uint32_t	nMessageSize {std::numeric_limits<uint32_t>::max()}
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 30 of file protocol.h.

Member Typedef Documentation

MessageStartChars

typedef unsigned char CMessageHeader::MessageStartChars[MESSAGE_START_SIZE]

Definition at line 40 of file protocol.h.

Constructor & Destructor Documentation

CMessageHeader() [1/2]

CMessageHeader::CMessageHeader ( )

explicitdefault

CMessageHeader() [2/2]

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

Construct a P2P message header from message-start characters, a command and the size of the message.

Note

Passing in a pszCommand longer than COMMAND_SIZE will result in a run-time assertion error.

Definition at line 90 of file protocol.cpp.

Here is the call graph for this function:

Member Function Documentation

GetCommand()

std::string CMessageHeader::GetCommand

(

)

const

Definition at line 102 of file protocol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

IsCommandValid()

bool CMessageHeader::IsCommandValid

(

)

const

Definition at line 107 of file protocol.cpp.

Here is the caller graph for this function:

SERIALIZE_METHODS()

CMessageHeader::SERIALIZE_METHODS ( CMessageHeader  , obj    )

inline

Definition at line 52 of file protocol.h.

Member Data Documentation

CHECKSUM_OFFSET

constexpr size_t CMessageHeader::CHECKSUM_OFFSET = MESSAGE_SIZE_OFFSET + MESSAGE_SIZE_SIZE

staticconstexpr

Definition at line 38 of file protocol.h.

CHECKSUM_SIZE

constexpr size_t CMessageHeader::CHECKSUM_SIZE = 4

staticconstexpr

Definition at line 36 of file protocol.h.

COMMAND_SIZE

constexpr size_t CMessageHeader::COMMAND_SIZE = 12

staticconstexpr

Definition at line 34 of file protocol.h.

HEADER_SIZE

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

staticconstexpr

Definition at line 39 of file protocol.h.

MESSAGE_SIZE_OFFSET

constexpr size_t CMessageHeader::MESSAGE_SIZE_OFFSET = MESSAGE_START_SIZE + COMMAND_SIZE

staticconstexpr

Definition at line 37 of file protocol.h.

MESSAGE_SIZE_SIZE

constexpr size_t CMessageHeader::MESSAGE_SIZE_SIZE = 4

staticconstexpr

Definition at line 35 of file protocol.h.

MESSAGE_START_SIZE

constexpr size_t CMessageHeader::MESSAGE_START_SIZE = 4

staticconstexpr

Definition at line 33 of file protocol.h.

nMessageSize

uint32_t CMessageHeader::nMessageSize {std::numeric_limits<uint32_t>::max()}

Definition at line 56 of file protocol.h.

pchChecksum

uint8_t CMessageHeader::pchChecksum[CHECKSUM_SIZE] {}

Definition at line 57 of file protocol.h.

pchCommand

char CMessageHeader::pchCommand[COMMAND_SIZE] {}

Definition at line 55 of file protocol.h.

pchMessageStart

char CMessageHeader::pchMessageStart[MESSAGE_START_SIZE] {}

Definition at line 54 of file protocol.h.

---

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

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