DelegateMQ
Loading...
Searching...
No Matches
DmqHeader Class Reference

Header for remote delegate messages. More...

#include <DmqHeader.h>

Public Member Functions

 DmqHeader ()=default
 
 DmqHeader (uint16_t id, uint16_t seqNum, uint16_t length=0)
 
uint16_t GetMarker () const
 
uint16_t GetId () const
 
uint16_t GetSeqNum () const
 
uint16_t GetLength () const
 
void SetId (uint16_t id)
 
void SetSeqNum (uint16_t seqNum)
 
void SetMarker (uint16_t marker)
 
void SetLength (uint16_t length)
 

Static Public Member Functions

static uint16_t GetNextSeqNum ()
 

Static Public Attributes

static const uint16_t MARKER = 0xAA55
 
static const size_t HEADER_SIZE = 8
 

Detailed Description

Header for remote delegate messages.

This class is a Plain Old Data (POD) container. It stores values in Host Byte Order. The Transport layer is responsible for converting to/from Network Byte Order (Big Endian) during transmission.

Constructor & Destructor Documentation

◆ DmqHeader() [1/2]

DmqHeader::DmqHeader ( )
default

◆ DmqHeader() [2/2]

DmqHeader::DmqHeader ( uint16_t id,
uint16_t seqNum,
uint16_t length = 0 )
inline

Member Function Documentation

◆ GetId()

uint16_t DmqHeader::GetId ( ) const
inline

◆ GetLength()

uint16_t DmqHeader::GetLength ( ) const
inline

◆ GetMarker()

uint16_t DmqHeader::GetMarker ( ) const
inline

◆ GetNextSeqNum()

static uint16_t DmqHeader::GetNextSeqNum ( )
inlinestatic

◆ GetSeqNum()

uint16_t DmqHeader::GetSeqNum ( ) const
inline

◆ SetId()

void DmqHeader::SetId ( uint16_t id)
inline

◆ SetLength()

void DmqHeader::SetLength ( uint16_t length)
inline

◆ SetMarker()

void DmqHeader::SetMarker ( uint16_t marker)
inline

◆ SetSeqNum()

void DmqHeader::SetSeqNum ( uint16_t seqNum)
inline

Member Data Documentation

◆ HEADER_SIZE

const size_t DmqHeader::HEADER_SIZE = 8
static

◆ MARKER

const uint16_t DmqHeader::MARKER = 0xAA55
static

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