This class implements the fragmentation sub-header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.2.1 Fragmentation subheader, page 39. More...

#include "wimax-mac-header.h"

Inheritance diagram for ns3::FragmentationSubheader:

Collaboration diagram for ns3::FragmentationSubheader:

Public Member Functions
	FragmentationSubheader ()

	~FragmentationSubheader () override

uint32_t	Deserialize (Buffer::Iterator start) override

uint8_t	GetFc () const
	Get FC field.

uint8_t	GetFsn () const
	Get FSN field.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

std::string	GetName () const
	Get name field.

uint32_t	GetSerializedSize () const override

void	Print (std::ostream &os) const override

void	Serialize (Buffer::Iterator start) const override

void	SetFc (uint8_t fc)
	Set FC field.

void	SetFsn (uint8_t fsn)
	Set FSN field.

Public Member Functions inherited from ns3::Header
	~Header () override

uint32_t	Deserialize (Buffer::Iterator start) override=0

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator.

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

virtual uint32_t	GetSerializedSize () const =0

void	Print (std::ostream &os) const override=0

virtual void	Serialize (Buffer::Iterator start) const =0

virtual uint32_t	Deserialize (Buffer::Iterator start)=0
	Deserialize the object from a buffer iterator.

virtual uint32_t	Deserialize (Buffer::Iterator start, Buffer::Iterator end)
	Deserialize the object from a buffer iterator.

virtual void	Print (std::ostream &os) const =0
	Print the object contents.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Header
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Chunk
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
uint8_t	m_fc
	Fragment Control.

uint8_t	m_fsn
	Fragment Sequence Number.

Additional Inherited Members
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

This class implements the fragmentation sub-header as described by IEEE Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband Wireless Access Systems 6.3.2.2.1 Fragmentation subheader, page 39.

Definition at line 471 of file wimax-mac-header.h.

Constructor & Destructor Documentation

◆ FragmentationSubheader()

ns3::FragmentationSubheader::FragmentationSubheader ( )

Definition at line 643 of file wimax-mac-header.cc.

◆ ~FragmentationSubheader()

ns3::FragmentationSubheader::~FragmentationSubheader ( )

override

Definition at line 649 of file wimax-mac-header.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::FragmentationSubheader::Deserialize ( Buffer::Iterator start )

overridevirtual

Parameters

start an iterator which points to where the header should read from.

Returns: the number of bytes read.

This method is used by Packet::RemoveHeader to re-create a header from the byte buffer of a packet. The data read is expected to match bit-for-bit the representation of this header in real networks.

Note that data is not actually removed from the buffer to which the iterator points. Both Packet::RemoveHeader() and Packet::PeekHeader() call Deserialize(), but only the RemoveHeader() has additional statements to remove the header bytes from the underlying buffer and associated metadata.

Implements ns3::Header.

Definition at line 721 of file wimax-mac-header.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_fc, m_fsn, and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ GetFc()

uint8_t ns3::FragmentationSubheader::GetFc ( ) const

Get FC field.

Returns: the FC

Definition at line 666 of file wimax-mac-header.cc.

References m_fc.

Referenced by ns3::BaseStationNetDevice::DoReceive(), ns3::SubscriberStationNetDevice::DoReceive(), and Ns3WimaxFragmentationTestCase::DoRun().

Here is the caller graph for this function:

◆ GetFsn()

uint8_t ns3::FragmentationSubheader::GetFsn ( ) const

Get FSN field.

Returns: the FSN

Definition at line 672 of file wimax-mac-header.cc.

References m_fsn.

◆ GetInstanceTypeId()

TypeId ns3::FragmentationSubheader::GetInstanceTypeId ( ) const

overridevirtual

Get the most derived TypeId for this Object.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Returns: The TypeId associated to the most-derived type of this instance.

Implements ns3::ObjectBase.

Definition at line 694 of file wimax-mac-header.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetName()

std::string ns3::FragmentationSubheader::GetName ( ) const

Get name field.

Returns: the name

Definition at line 678 of file wimax-mac-header.cc.

◆ GetSerializedSize()

uint32_t ns3::FragmentationSubheader::GetSerializedSize ( ) const

overridevirtual

Returns: the expected size of the header.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. This method should return the number of bytes which are needed to store the full header data by Serialize.

Implements ns3::Header.

Definition at line 707 of file wimax-mac-header.cc.

Referenced by ns3::WimaxMacQueue::Dequeue().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::FragmentationSubheader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 684 of file wimax-mac-header.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Print()

void ns3::FragmentationSubheader::Print ( std::ostream & os ) const

overridevirtual

Parameters

os output stream This method is used by Packet::Print to print the content of a header as ascii data to a c++ output stream. Although the header is free to format its output as it wishes, it is recommended to follow a few rules to integrate with the packet pretty printer: start with flags, small field values located between a pair of parens. Values should be separated by whitespace. Follow the parens with the important fields, separated by whitespace. i.e.: (field1 val1 field2 val2 field3 val3) field4 val4 field5 val5

Implements ns3::Header.

Definition at line 700 of file wimax-mac-header.cc.

References m_fc, and m_fsn.

◆ Serialize()

void ns3::FragmentationSubheader::Serialize ( Buffer::Iterator start ) const

overridevirtual

Parameters

start an iterator which points to where the header should be written.

This method is used by Packet::AddHeader to store a header into the byte buffer of a packet. The data written is expected to match bit-for-bit the representation of this header in a real network.

Implements ns3::Header.

Definition at line 713 of file wimax-mac-header.cc.

References m_fc, m_fsn, and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ SetFc()

void ns3::FragmentationSubheader::SetFc ( uint8_t fc )

Set FC field.

Parameters

fc the FC

Definition at line 654 of file wimax-mac-header.cc.

References m_fc.

Referenced by ns3::WimaxMacQueue::Dequeue().

Here is the caller graph for this function:

◆ SetFsn()

void ns3::FragmentationSubheader::SetFsn ( uint8_t fsn )

Set FSN field.

Parameters

fsn the FSN

Definition at line 660 of file wimax-mac-header.cc.

References m_fsn.

Referenced by ns3::WimaxMacQueue::Dequeue().

Here is the caller graph for this function:

Member Data Documentation

◆ m_fc

uint8_t ns3::FragmentationSubheader::m_fc

private

Fragment Control.

Definition at line 516 of file wimax-mac-header.h.

Referenced by Deserialize(), GetFc(), Print(), Serialize(), and SetFc().

◆ m_fsn

uint8_t ns3::FragmentationSubheader::m_fsn

private

Fragment Sequence Number.

Definition at line 517 of file wimax-mac-header.h.

Referenced by Deserialize(), GetFsn(), Print(), Serialize(), and SetFsn().

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

src/wimax/model/wimax-mac-header.h
src/wimax/model/wimax-mac-header.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FragmentationSubheader()

◆ ~FragmentationSubheader()

Member Function Documentation

◆ Deserialize()

◆ GetFc()

◆ GetFsn()

◆ GetInstanceTypeId()

◆ GetName()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetFc()

◆ SetFsn()

Member Data Documentation

◆ m_fc

◆ m_fsn