[#CMessageHeader]
= CMessageHeader
:mrdocs:

Message header. (4) message start. (12) message type. (4) size. (4) checksum.

== Synopsis

Declared in `<protocol.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class CMessageHeader;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:CMessageHeader/2constructor-0e7.adoc[`CMessageHeader`]         [.small]#[constructor]#
| Constructors
| xref:CMessageHeader/GetMessageType.adoc[`GetMessageType`] 
| Returns the message type as a string.
| xref:CMessageHeader/IsMessageTypeValid.adoc[`IsMessageTypeValid`] 
| Returns whether the message type field contains a valid, well‐formed value.
|===


== Data Members

[cols="1,4"]
|===
| Name| Description
| xref:CMessageHeader/m_msg_type.adoc[`m_msg_type`] 
| Message type as a fixed‐width, null‐padded field.
| xref:CMessageHeader/nMessageSize.adoc[`nMessageSize`] 
| Size of the message payload in bytes.
| xref:CMessageHeader/pchChecksum.adoc[`pchChecksum`] 
| Checksum of the message payload.
| xref:CMessageHeader/pchMessageStart.adoc[`pchMessageStart`] 
| Network magic bytes marking the start of the message.
|===


== Static Data Members

[cols="1,4"]
|===
| Name| Description
| xref:CMessageHeader/CHECKSUM_OFFSET.adoc[`CHECKSUM_OFFSET`] 
| Byte offset of the checksum field within the header.
| xref:CMessageHeader/CHECKSUM_SIZE.adoc[`CHECKSUM_SIZE`] 
| Number of bytes used for the payload checksum.
| xref:CMessageHeader/HEADER_SIZE.adoc[`HEADER_SIZE`] 
| Total size of a serialized message header in bytes.
| xref:CMessageHeader/MESSAGE_SIZE_OFFSET.adoc[`MESSAGE_SIZE_OFFSET`] 
| Byte offset of the payload size field within the header.
| xref:CMessageHeader/MESSAGE_SIZE_SIZE.adoc[`MESSAGE_SIZE_SIZE`] 
| Number of bytes used to encode the payload size.
| xref:CMessageHeader/MESSAGE_TYPE_SIZE.adoc[`MESSAGE_TYPE_SIZE`] 
| Number of bytes reserved for the message type field.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#