Implement the header for management frames of type Delete Block Ack. More...

#include "mgt-action-headers.h"

Inheritance diagram for ns3::MgtDelBaHeader:

Collaboration diagram for ns3::MgtDelBaHeader:

Public Member Functions
uint32_t	Deserialize (Buffer::Iterator start) override

std::optional< Mac48Address >	GetGcrGroupAddress () const

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

uint32_t	GetSerializedSize () const override

uint8_t	GetTid () const
	Return the Traffic ID (TID).

bool	IsByOriginator () const
	Check if the initiator bit in the DELBA is set.

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

void	Serialize (Buffer::Iterator start) const override

void	SetByOriginator ()
	Set the initiator bit in the DELBA.

void	SetByRecipient ()
	Un-set the initiator bit in the DELBA.

void	SetGcrGroupAddress (const Mac48Address &address)
	Set the GCR Group address.

void	SetTid (uint8_t tid)
	Set Traffic ID (TID).

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 Member Functions
uint16_t	GetParameterSet () const
	Return the raw parameter set.

void	SetParameterSet (uint16_t params)
	Set the parameter set from the given raw value.

Private Attributes
std::optional< Mac48Address >	m_gcrGroupAddress
	GCR Group Address (optional)

uint16_t	m_initiator {0}
	initiator

uint16_t	m_reasonCode {1}
	Not used for now.

uint16_t	m_tid {0}
	Traffic ID.

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

Implement the header for management frames of type Delete Block Ack.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Wifi

Size of this type is 24 bytes (on a 64-bit architecture).

Definition at line 565 of file mgt-action-headers.h.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::MgtDelBaHeader::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 1220 of file mgt-action-headers.cc.

References ns3::WifiInformationElement::DeserializeIfPresent(), ns3::Buffer::Iterator::GetDistanceFrom(), ns3::GcrGroupAddress::m_gcrGroupAddress, m_gcrGroupAddress, m_reasonCode, ns3::Buffer::Iterator::ReadLsbtohU16(), and SetParameterSet().

Here is the call graph for this function:

◆ GetGcrGroupAddress()

std::optional< Mac48Address > ns3::MgtDelBaHeader::GetGcrGroupAddress ( ) const

Returns: the GCR Group Address, if present

Definition at line 1276 of file mgt-action-headers.cc.

References m_gcrGroupAddress.

◆ GetInstanceTypeId()

TypeId ns3::MgtDelBaHeader::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 1176 of file mgt-action-headers.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetParameterSet()

uint16_t ns3::MgtDelBaHeader::GetParameterSet ( ) const

private

Return the raw parameter set.

Returns: the raw parameter set

Definition at line 1282 of file mgt-action-headers.cc.

References m_initiator, and m_tid.

Referenced by Serialize().

Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::MgtDelBaHeader::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 1192 of file mgt-action-headers.cc.

References ns3::WifiInformationElement::GetSerializedSize(), and m_gcrGroupAddress.

Here is the call graph for this function:

◆ GetTid()

uint8_t ns3::MgtDelBaHeader::GetTid ( ) const

Return the Traffic ID (TID).

Returns: TID

Definition at line 1243 of file mgt-action-headers.cc.

References m_tid, and NS_ASSERT.

Referenced by ns3::GetTid(), ns3::QosTxop::GotDelBaFrame(), ns3::HtFrameExchangeManager::NotifyReceivedNormalAck(), and ns3::HtFrameExchangeManager::ReceiveMgtAction().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MgtDelBaHeader::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 1166 of file mgt-action-headers.cc.

References ns3::TypeId::SetParent().

Referenced by GetInstanceTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsByOriginator()

bool ns3::MgtDelBaHeader::IsByOriginator ( ) const

Check if the initiator bit in the DELBA is set.

Returns: true if the initiator bit in the DELBA is set, false otherwise

Definition at line 1237 of file mgt-action-headers.cc.

References m_initiator.

Referenced by ns3::HtFrameExchangeManager::NotifyReceivedNormalAck(), and ns3::HtFrameExchangeManager::ReceiveMgtAction().

Here is the caller graph for this function:

◆ Print()

void ns3::MgtDelBaHeader::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 1182 of file mgt-action-headers.cc.

References m_gcrGroupAddress, m_initiator, and m_tid.

◆ Serialize()

void ns3::MgtDelBaHeader::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 1206 of file mgt-action-headers.cc.

References GetParameterSet(), ns3::GcrGroupAddress::m_gcrGroupAddress, m_gcrGroupAddress, m_reasonCode, ns3::WifiInformationElement::Serialize(), and ns3::Buffer::Iterator::WriteHtolsbU16().

Here is the call graph for this function:

◆ SetByOriginator()

void ns3::MgtDelBaHeader::SetByOriginator ( )

Set the initiator bit in the DELBA.

Definition at line 1251 of file mgt-action-headers.cc.

References m_initiator.

Referenced by ns3::HtFrameExchangeManager::SendDelbaFrame().

Here is the caller graph for this function:

◆ SetByRecipient()

void ns3::MgtDelBaHeader::SetByRecipient ( )

Un-set the initiator bit in the DELBA.

Definition at line 1257 of file mgt-action-headers.cc.

References m_initiator.

Referenced by ns3::HtFrameExchangeManager::SendDelbaFrame().

Here is the caller graph for this function:

◆ SetGcrGroupAddress()

void ns3::MgtDelBaHeader::SetGcrGroupAddress ( const Mac48Address & address )

Set the GCR Group address.

Parameters

address the GCR Group Address

Definition at line 1270 of file mgt-action-headers.cc.

References m_gcrGroupAddress.

◆ SetParameterSet()

void ns3::MgtDelBaHeader::SetParameterSet ( uint16_t params )

private

Set the parameter set from the given raw value.

Parameters

params raw parameter set value

Definition at line 1291 of file mgt-action-headers.cc.

References m_initiator, and m_tid.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ SetTid()

void ns3::MgtDelBaHeader::SetTid ( uint8_t tid )

Set Traffic ID (TID).

Parameters

tid	traffic ID

Definition at line 1263 of file mgt-action-headers.cc.

References m_tid, and NS_ASSERT.

Referenced by ns3::HtFrameExchangeManager::SendDelbaFrame().

Here is the caller graph for this function:

Member Data Documentation

◆ m_gcrGroupAddress

std::optional<Mac48Address> ns3::MgtDelBaHeader::m_gcrGroupAddress

private

GCR Group Address (optional)

Definition at line 635 of file mgt-action-headers.h.

Referenced by Deserialize(), GetGcrGroupAddress(), GetSerializedSize(), Print(), Serialize(), and SetGcrGroupAddress().

◆ m_initiator

uint16_t ns3::MgtDelBaHeader::m_initiator {0}

private

initiator

Definition at line 632 of file mgt-action-headers.h.

Referenced by GetParameterSet(), IsByOriginator(), Print(), SetByOriginator(), SetByRecipient(), and SetParameterSet().

◆ m_reasonCode

uint16_t ns3::MgtDelBaHeader::m_reasonCode {1}

private

Not used for now.

Always set to 1: "Unspecified reason"

Definition at line 634 of file mgt-action-headers.h.

Referenced by Deserialize(), and Serialize().

◆ m_tid

uint16_t ns3::MgtDelBaHeader::m_tid {0}

private

Traffic ID.

Definition at line 633 of file mgt-action-headers.h.

Referenced by GetParameterSet(), GetTid(), Print(), SetParameterSet(), and SetTid().

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

src/wifi/model/mgt-action-headers.h
src/wifi/model/mgt-action-headers.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Deserialize()

◆ GetGcrGroupAddress()

◆ GetInstanceTypeId()

◆ GetParameterSet()

◆ GetSerializedSize()

◆ GetTid()

◆ GetTypeId()

◆ IsByOriginator()

◆ Print()

◆ Serialize()

◆ SetByOriginator()

◆ SetByRecipient()

◆ SetGcrGroupAddress()

◆ SetParameterSet()

◆ SetTid()

Member Data Documentation

◆ m_gcrGroupAddress

◆ m_initiator

◆ m_reasonCode

◆ m_tid