EMANE  1.2.1
EMANE::CommonMACHeader Class Reference

#include <commonmacheader.h>

Public Member Functions

 CommonMACHeader (RegistrationId registrationId, std::uint64_t u64SequenceNumber)
 
 CommonMACHeader (UpstreamPacket &pkt)
 
 CommonMACHeader (CommonMACHeader &&rvalue)
 
 ~CommonMACHeader ()
 
RegistrationId getRegistrationId () const
 
std::uint64_t getSequenceNumber () const
 
void prependTo (DownstreamPacket &pkt) const
 
Strings format () const
 

Detailed Description

Definition at line 47 of file commonmacheader.h.

Constructor & Destructor Documentation

◆ CommonMACHeader() [1/3]

EMANE::CommonMACHeader::CommonMACHeader ( RegistrationId  registrationId,
std::uint64_t  u64SequenceNumber 
)

Create a CommonMACHeader

Parameters
registrationIdUnique MAC registration id
u64SequenceNumberPacket sequence number

Definition at line 95 of file commonmacheader.cc.

◆ CommonMACHeader() [2/3]

EMANE::CommonMACHeader::CommonMACHeader ( UpstreamPacket pkt)

Creates a CommonMACHeader instance by stripping an UpstreamPacket

Parameters
pktUpstreamPacket that is stripped in order to create the instance
Exceptions
SerializationExceptionwhen the data stripped cannot be de-serialized into a CommonMACPHYHeader

Definition at line 61 of file commonmacheader.cc.

◆ CommonMACHeader() [3/3]

EMANE::CommonMACHeader::CommonMACHeader ( CommonMACHeader &&  rvalue)

Creates a CommonMACHeader instance by moving another instance

Definition at line 102 of file commonmacheader.cc.

◆ ~CommonMACHeader()

EMANE::CommonMACHeader::~CommonMACHeader ( )

Destroys an instance

Definition at line 106 of file commonmacheader.cc.

Member Function Documentation

◆ format()

EMANE::Strings EMANE::CommonMACHeader::format ( ) const

Definition at line 139 of file commonmacheader.cc.

◆ getRegistrationId()

EMANE::RegistrationId EMANE::CommonMACHeader::getRegistrationId ( ) const

Gets the MAC registration id

Returns
id

Definition at line 108 of file commonmacheader.cc.

◆ getSequenceNumber()

std::uint64_t EMANE::CommonMACHeader::getSequenceNumber ( ) const

Gets the MAC header packet sequence number

Returns
sequence number

Definition at line 113 of file commonmacheader.cc.

◆ prependTo()

void EMANE::CommonMACHeader::prependTo ( DownstreamPacket pkt) const

Prepends CommonMACHeader to downstream packet

Parameters
pktPacket to prepend header
Exceptions
SerializationException

Definition at line 119 of file commonmacheader.cc.


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