Burger::NetPlay::MessageHeader_t Struct Reference

Base header for a network packet. More...

Inheritance diagram for Burger::NetPlay::MessageHeader_t:

Public Member Functions
void	ClearHeader (void)
	Reset a message header.

Public Attributes
uint32_t	m_uVersion
	Packet version "kVersion" and special flags.
uint32_t	m_uMessageID
	Message ID code to denote what the message actually is ( ePacketMessage )
PlayerID	m_uFrom
	PlayerID of the sender.
PlayerID	m_uTo
	PlayerID or GroupID of the destination.
uint32_t	m_uSignature
	Incrementing message ID number for uniqueness.
uint32_t	m_uTimeMark
	Message timestamp in milliseconds.
uint32_t	m_uSize
	Size of the entire message packet in bytes.

Detailed Description

Base header for a network packet.

---

All NetPlay internal messages will contain this data prefix in all packets send across the wire. All values are stored in network endian (Big) for consistency for all platforms.

Member Function Documentation

ClearHeader()

void BURGER_API Burger::NetPlay::MessageHeader_t::ClearHeader

(

void

)

Reset a message header.

---

Erase the message header to defaults. All values are set to zero, except m_uVersion with is set to kVersion and m_uSize which is set to the size of the base structure

Member Data Documentation

m_uFrom

PlayerID Burger::NetPlay::MessageHeader_t::m_uFrom

PlayerID of the sender.

m_uMessageID

uint32_t Burger::NetPlay::MessageHeader_t::m_uMessageID

Message ID code to denote what the message actually is ( ePacketMessage )

m_uSignature

uint32_t Burger::NetPlay::MessageHeader_t::m_uSignature

Incrementing message ID number for uniqueness.

m_uSize

uint32_t Burger::NetPlay::MessageHeader_t::m_uSize

Size of the entire message packet in bytes.

m_uTimeMark

uint32_t Burger::NetPlay::MessageHeader_t::m_uTimeMark

Message timestamp in milliseconds.

m_uTo

PlayerID Burger::NetPlay::MessageHeader_t::m_uTo

PlayerID or GroupID of the destination.

m_uVersion

uint32_t Burger::NetPlay::MessageHeader_t::m_uVersion

Packet version "kVersion" and special flags.