ns3::SatArqHeader Class Reference

ARQ header implementation contains the sequence number related to the packet in question. More...

#include "satellite-arq-header.h"

+ Inheritance diagram for ns3::SatArqHeader:
+ Collaboration diagram for ns3::SatArqHeader:

Public Member Functions

 SatArqHeader ()
 Constructor. More...
 
 ~SatArqHeader ()
 Destructor for SatArqHeader. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)
 Deserializes information from buffer to this instance of SatArqHeader. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the type ID of instance. More...
 
uint8_t GetSeqNo () const
 Get sequence number. More...
 
virtual uint32_t GetSerializedSize (void) const
 Get serialized size of SatArqHeader. More...
 
virtual void Print (std::ostream &os) const
 Print time stamp of this instance of SatArqHeader. More...
 
virtual void Serialize (Buffer::Iterator start) const
 Serializes information to buffer from this instance of SatArqHeader. More...
 
void SetSeqNo (uint8_t seqNo)
 Set sequence number. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

uint8_t m_seqNo
 Sequence number represented by one Byte. More...
 

Detailed Description

ARQ header implementation contains the sequence number related to the packet in question.

Sequence number is identified with one byte, thus it may range between 0 - 255.

Definition at line 39 of file satellite-arq-header.h.

Constructor & Destructor Documentation

◆ SatArqHeader()

ns3::SatArqHeader::SatArqHeader ( )

Constructor.

Definition at line 32 of file satellite-arq-header.cc.

◆ ~SatArqHeader()

ns3::SatArqHeader::~SatArqHeader ( )

Destructor for SatArqHeader.

Definition at line 37 of file satellite-arq-header.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::SatArqHeader::Deserialize ( Buffer::Iterator  start)
virtual

Deserializes information from buffer to this instance of SatArqHeader.

Parameters
startBuffer from which the information is deserialized
Returns
Serialized size of the buffer

Definition at line 65 of file satellite-arq-header.cc.

References GetSerializedSize(), and m_seqNo.

+ Here is the call graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::SatArqHeader::GetInstanceTypeId ( void  ) const
virtual

Get the type ID of instance.

Returns
the object TypeId

Definition at line 81 of file satellite-arq-header.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSeqNo()

uint8_t ns3::SatArqHeader::GetSeqNo ( ) const

Get sequence number.

Returns
Sequence number

Definition at line 87 of file satellite-arq-header.cc.

References m_seqNo.

Referenced by ns3::SatGenericStreamEncapsulatorArq::ReceivePdu(), and ns3::SatReturnLinkEncapsulatorArq::ReceivePdu().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::SatArqHeader::GetSerializedSize ( void  ) const
virtual

Get serialized size of SatArqHeader.

Returns
Serialized size in bytes

Definition at line 50 of file satellite-arq-header.cc.

Referenced by Deserialize().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SatArqHeader::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 42 of file satellite-arq-header.cc.

Referenced by GetInstanceTypeId().

+ Here is the caller graph for this function:

◆ Print()

void ns3::SatArqHeader::Print ( std::ostream &  os) const
virtual

Print time stamp of this instance of SatArqHeader.

Parameters
&osOutput stream to which tag timestamp is printed.

Definition at line 75 of file satellite-arq-header.cc.

References m_seqNo.

◆ Serialize()

void ns3::SatArqHeader::Serialize ( Buffer::Iterator  start) const
virtual

Serializes information to buffer from this instance of SatArqHeader.

Parameters
startBuffer in which the information is serialized

Definition at line 57 of file satellite-arq-header.cc.

References m_seqNo.

◆ SetSeqNo()

void ns3::SatArqHeader::SetSeqNo ( uint8_t  seqNo)

Set sequence number.

Parameters
seqNoSequence number

Definition at line 94 of file satellite-arq-header.cc.

References m_seqNo.

Referenced by ns3::SatGenericStreamEncapsulatorArq::NotifyTxOpportunity(), and ns3::SatReturnLinkEncapsulatorArq::NotifyTxOpportunity().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_seqNo

uint8_t ns3::SatArqHeader::m_seqNo
private

Sequence number represented by one Byte.

Definition at line 105 of file satellite-arq-header.h.

Referenced by Deserialize(), GetSeqNo(), Print(), Serialize(), and SetSeqNo().


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