Header used for ACK packets by protocol UanMacRc. More...

#include "uan-header-rc.h"

Inheritance diagram for ns3::UanHeaderRcAck:

Collaboration diagram for ns3::UanHeaderRcAck:

Public Member Functions
	UanHeaderRcAck ()
	Default constructor.

	~UanHeaderRcAck () override
	Destructor.

void	AddNackedFrame (uint8_t frame)
	NACK a frame.

uint32_t	Deserialize (Buffer::Iterator start) override

uint8_t	GetFrameNo () const
	Get the reservation frame number being ACKed.

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

const std::set< uint8_t > &	GetNackedFrames () const
	Get the set of NACK'ed frames.

uint8_t	GetNoNacks () const
	Get the number of data frames being NACKed.

uint32_t	GetSerializedSize () const override

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

void	Serialize (Buffer::Iterator start) const override

void	SetFrameNo (uint8_t frameNo)
	Set the frame number of the reservation being acknowledged.

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

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

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

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) 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.

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 ()
	Register this type.

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_frameNo
	Next frame number.

std::set< uint8_t >	m_nackedFrames
	Marker for nacked frames.

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 Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Header used for ACK packets by protocol UanMacRc.

Definition at line 446 of file uan-header-rc.h.

Constructor & Destructor Documentation

◆ UanHeaderRcAck()

ns3::UanHeaderRcAck::UanHeaderRcAck ( )

Default constructor.

Definition at line 538 of file uan-header-rc.cc.

◆ ~UanHeaderRcAck()

ns3::UanHeaderRcAck::~UanHeaderRcAck ( )

override

Destructor.

Definition at line 543 of file uan-header-rc.cc.

References m_nackedFrames.

Member Function Documentation

◆ AddNackedFrame()

void ns3::UanHeaderRcAck::AddNackedFrame ( uint8_t frame )

NACK a frame.

Parameters

frame The data frame number being NACKed.

Definition at line 565 of file uan-header-rc.cc.

References m_nackedFrames.

Referenced by ns3::UanMacRcGw::EndCycle().

Here is the caller graph for this function:

◆ Deserialize()

uint32_t ns3::UanHeaderRcAck::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 607 of file uan-header-rc.cc.

References ns3::Buffer::Iterator::GetDistanceFrom(), m_frameNo, m_nackedFrames, and ns3::Buffer::Iterator::ReadU8().

Here is the call graph for this function:

◆ GetFrameNo()

uint8_t ns3::UanHeaderRcAck::GetFrameNo ( ) const

Get the reservation frame number being ACKed.

Returns: The frame number.

Definition at line 577 of file uan-header-rc.cc.

References m_frameNo.

Referenced by ns3::UanMacRc::ProcessAck().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::UanHeaderRcAck::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 638 of file uan-header-rc.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetNackedFrames()

const std::set< uint8_t > & ns3::UanHeaderRcAck::GetNackedFrames ( ) const

Get the set of NACK'ed frames.

Returns: The set of NACK'ed frames.

Definition at line 571 of file uan-header-rc.cc.

References m_nackedFrames.

Referenced by ns3::UanMacRc::ProcessAck().

Here is the caller graph for this function:

◆ GetNoNacks()

uint8_t ns3::UanHeaderRcAck::GetNoNacks ( ) const

Get the number of data frames being NACKed.

Returns: The number of NACKed frames.

Definition at line 583 of file uan-header-rc.cc.

References m_nackedFrames.

Referenced by GetSerializedSize(), Print(), ns3::UanMacRc::ProcessAck(), and Serialize().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::UanHeaderRcAck::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 589 of file uan-header-rc.cc.

References GetNoNacks().

Referenced by ns3::UanMacRcGw::UanMacRcGw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::UanHeaderRcAck::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 549 of file uan-header-rc.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::UanHeaderRcAck::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 621 of file uan-header-rc.cc.

References GetNoNacks(), m_frameNo, and m_nackedFrames.

Here is the call graph for this function:

◆ Serialize()

void ns3::UanHeaderRcAck::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 595 of file uan-header-rc.cc.

References GetNoNacks(), m_frameNo, and m_nackedFrames.

Here is the call graph for this function:

◆ SetFrameNo()

void ns3::UanHeaderRcAck::SetFrameNo ( uint8_t frameNo )

Set the frame number of the reservation being acknowledged.

Parameters

frameNo The frame number.

Definition at line 559 of file uan-header-rc.cc.

References m_frameNo.

Referenced by ns3::UanMacRcGw::EndCycle().

Here is the caller graph for this function:

Member Data Documentation

◆ m_frameNo

uint8_t ns3::UanHeaderRcAck::m_frameNo

private

Next frame number.

Definition at line 500 of file uan-header-rc.h.

Referenced by Deserialize(), GetFrameNo(), Print(), Serialize(), and SetFrameNo().

◆ m_nackedFrames

std::set<uint8_t> ns3::UanHeaderRcAck::m_nackedFrames

private

Marker for nacked frames.

Definition at line 501 of file uan-header-rc.h.

Referenced by ~UanHeaderRcAck(), AddNackedFrame(), Deserialize(), GetNackedFrames(), GetNoNacks(), Print(), and Serialize().

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

src/uan/model/uan-header-rc.h
src/uan/model/uan-header-rc.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UanHeaderRcAck()

◆ ~UanHeaderRcAck()

Member Function Documentation

◆ AddNackedFrame()

◆ Deserialize()

◆ GetFrameNo()

◆ GetInstanceTypeId()

◆ GetNackedFrames()

◆ GetNoNacks()

◆ GetSerializedSize()

◆ GetTypeId()

◆ Print()

◆ Serialize()

◆ SetFrameNo()

Member Data Documentation

◆ m_frameNo

◆ m_nackedFrames