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

#include "mgt-action-headers.h"

Inheritance diagram for ns3::MgtAddBaRequestHeader:

Collaboration diagram for ns3::MgtAddBaRequestHeader:

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

uint16_t	GetBufferSize () const
	Return the buffer size.

std::optional< Mac48Address >	GetGcrGroupAddress () const

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

uint32_t	GetSerializedSize () const override

uint16_t	GetStartingSequence () const
	Return the starting sequence number.

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

uint16_t	GetTimeout () const
	Return the timeout.

bool	IsAmsduSupported () const
	Return whether A-MSDU capability is supported.

bool	IsImmediateBlockAck () const
	Return whether the Block Ack policy is immediate Block Ack.

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

void	Serialize (Buffer::Iterator start) const override

void	SetAmsduSupport (bool supported)
	Enable or disable A-MSDU support.

void	SetBufferSize (uint16_t size)
	Set buffer size.

void	SetDelayedBlockAck ()
	Enable delayed BlockAck.

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

void	SetImmediateBlockAck ()
	Enable immediate BlockAck.

void	SetStartingSequence (uint16_t seq)
	Set the starting sequence number.

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

void	SetTimeout (uint16_t timeout)
	Set timeout.

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.

uint16_t	GetStartingSequenceControl () const
	Return the raw sequence control.

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

void	SetStartingSequenceControl (uint16_t seqControl)
	Set sequence control with the given raw value.

Private Attributes
bool	m_amsduSupport {true}
	Flag if A-MSDU is supported.

uint16_t	m_bufferSize {0}
	Buffer size.

uint8_t	m_dialogToken {1}
	Not used for now.

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

uint8_t	m_policy {1}
	Block Ack policy.

uint16_t	m_startingSeq {0}
	Starting sequence number.

uint8_t	m_tid {0}
	Traffic ID.

uint16_t	m_timeoutValue {0}
	Timeout.

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 Add Block Ack request.

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 32 bytes (on a 64-bit architecture).

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

Member Function Documentation

◆ Deserialize()

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

References ns3::WifiInformationElement::DeserializeIfPresent(), ns3::AddbaExtension::ExtParamSet::extBufferSize, ns3::Buffer::Iterator::GetDistanceFrom(), m_bufferSize, m_dialogToken, ns3::AddbaExtension::m_extParamSet, ns3::GcrGroupAddress::m_gcrGroupAddress, m_gcrGroupAddress, m_timeoutValue, ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadU8(), SetParameterSet(), and SetStartingSequenceControl().

Here is the call graph for this function:

◆ GetBufferSize()

uint16_t ns3::MgtAddBaRequestHeader::GetBufferSize ( ) const

Return the buffer size.

Returns: the buffer size.

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

References m_bufferSize.

Referenced by ns3::BlockAckManager::CreateOriginatorAgreement().

Here is the caller graph for this function:

◆ GetGcrGroupAddress()

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

Returns: the GCR Group Address, if present

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

References m_gcrGroupAddress.

Referenced by ns3::BlockAckManager::CreateOriginatorAgreement(), and ns3::HtFrameExchangeManager::SendAddBaResponse().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

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

References GetTypeId().

Here is the call graph for this function:

◆ GetParameterSet()

uint16_t ns3::MgtAddBaRequestHeader::GetParameterSet ( ) const

private

Return the raw parameter set.

Returns: the raw parameter set

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

References m_amsduSupport, m_bufferSize, m_policy, and m_tid.

Referenced by Serialize().

Here is the caller graph for this function:

◆ GetSerializedSize()

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

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

Here is the call graph for this function:

◆ GetStartingSequence()

uint16_t ns3::MgtAddBaRequestHeader::GetStartingSequence ( ) const

Return the starting sequence number.

Returns: the starting sequence number

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

References m_startingSeq.

Referenced by ns3::BlockAckManager::CreateOriginatorAgreement(), and ns3::HtFrameExchangeManager::SendAddBaResponse().

Here is the caller graph for this function:

◆ GetStartingSequenceControl()

uint16_t ns3::MgtAddBaRequestHeader::GetStartingSequenceControl ( ) const

private

Return the raw sequence control.

Returns: the raw sequence control

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

References m_startingSeq.

Referenced by Serialize().

Here is the caller graph for this function:

◆ GetTid()

uint8_t ns3::MgtAddBaRequestHeader::GetTid ( ) const

Return the Traffic ID (TID).

Returns: TID

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

References m_tid.

Referenced by ns3::BlockAckManager::CreateOriginatorAgreement(), AmpduAggregationTest::EstablishAgreement(), ns3::GetTid(), ns3::HtFrameExchangeManager::NotifyReceivedNormalAck(), and ns3::HtFrameExchangeManager::SendAddBaResponse().

Here is the caller graph for this function:

◆ GetTimeout()

uint16_t ns3::MgtAddBaRequestHeader::GetTimeout ( ) const

Return the timeout.

Returns: timeout

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

References m_timeoutValue.

Referenced by ns3::BlockAckManager::CreateOriginatorAgreement(), AmpduAggregationTest::EstablishAgreement(), and ns3::HtFrameExchangeManager::SendAddBaResponse().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MgtAddBaRequestHeader::GetTypeId ( )

static

Register this type.

Returns: The TypeId.

Definition at line 725 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:

◆ IsAmsduSupported()

bool ns3::MgtAddBaRequestHeader::IsAmsduSupported ( ) const

Return whether A-MSDU capability is supported.

Returns: true is A-MSDU is supported, false otherwise

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

References m_amsduSupport.

Referenced by ns3::BlockAckManager::CreateOriginatorAgreement(), AmpduAggregationTest::EstablishAgreement(), and ns3::HtFrameExchangeManager::SendAddBaResponse().

Here is the caller graph for this function:

◆ IsImmediateBlockAck()

bool ns3::MgtAddBaRequestHeader::IsImmediateBlockAck ( ) const

Return whether the Block Ack policy is immediate Block Ack.

Returns: true if immediate Block Ack is being used, false otherwise

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

References m_policy.

Referenced by ns3::BlockAckManager::CreateOriginatorAgreement(), and ns3::HtFrameExchangeManager::SendAddBaResponse().

Here is the caller graph for this function:

◆ Print()

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

References m_amsduSupport, m_bufferSize, m_gcrGroupAddress, m_policy, m_startingSeq, m_tid, and m_timeoutValue.

◆ Serialize()

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

References ns3::AddbaExtension::ExtParamSet::extBufferSize, GetParameterSet(), GetStartingSequenceControl(), m_bufferSize, m_dialogToken, ns3::AddbaExtension::m_extParamSet, ns3::GcrGroupAddress::m_gcrGroupAddress, m_gcrGroupAddress, m_timeoutValue, ns3::WifiInformationElement::Serialize(), ns3::Buffer::Iterator::WriteHtolsbU16(), and ns3::Buffer::Iterator::WriteU8().

Here is the call graph for this function:

◆ SetAmsduSupport()

void ns3::MgtAddBaRequestHeader::SetAmsduSupport ( bool supported )

Enable or disable A-MSDU support.

Parameters

supported enable or disable A-MSDU support

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

References m_amsduSupport.

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

Here is the caller graph for this function:

◆ SetBufferSize()

void ns3::MgtAddBaRequestHeader::SetBufferSize ( uint16_t size )

Set buffer size.

Parameters

size	buffer size

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

References m_bufferSize.

Referenced by AmpduAggregationTest::EstablishAgreement(), and ns3::HtFrameExchangeManager::SendAddBaRequest().

Here is the caller graph for this function:

◆ SetDelayedBlockAck()

void ns3::MgtAddBaRequestHeader::SetDelayedBlockAck ( )

Enable delayed BlockAck.

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

References m_policy.

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

Here is the caller graph for this function:

◆ SetGcrGroupAddress()

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

Set the GCR Group address.

Parameters

address the GCR Group Address

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

References m_gcrGroupAddress.

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

Here is the caller graph for this function:

◆ SetImmediateBlockAck()

void ns3::MgtAddBaRequestHeader::SetImmediateBlockAck ( )

Enable immediate BlockAck.

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

References m_policy.

Referenced by AmpduAggregationTest::EstablishAgreement(), and ns3::HtFrameExchangeManager::SendAddBaRequest().

Here is the caller graph for this function:

◆ SetParameterSet()

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

private

Set the parameter set from the given raw value.

Parameters

params raw parameter set value

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

References m_amsduSupport, m_bufferSize, m_policy, and m_tid.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ SetStartingSequence()

void ns3::MgtAddBaRequestHeader::SetStartingSequence ( uint16_t seq )

Set the starting sequence number.

Parameters

seq	the starting sequence number

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

References m_startingSeq.

Referenced by AmpduAggregationTest::EstablishAgreement(), and ns3::HtFrameExchangeManager::SendAddBaRequest().

Here is the caller graph for this function:

◆ SetStartingSequenceControl()

void ns3::MgtAddBaRequestHeader::SetStartingSequenceControl ( uint16_t seqControl )

private

Set sequence control with the given raw value.

Parameters

seqControl the raw sequence control

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

References m_startingSeq.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ SetTid()

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

Set Traffic ID (TID).

Parameters

tid	traffic ID

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

References m_tid, and NS_ASSERT.

Referenced by AmpduAggregationTest::EstablishAgreement(), and ns3::HtFrameExchangeManager::SendAddBaRequest().

Here is the caller graph for this function:

◆ SetTimeout()

void ns3::MgtAddBaRequestHeader::SetTimeout ( uint16_t timeout )

Set timeout.

Parameters

timeout timeout

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

References m_timeoutValue, and timeout.

Referenced by AmpduAggregationTest::EstablishAgreement(), and ns3::HtFrameExchangeManager::SendAddBaRequest().

Here is the caller graph for this function:

Member Data Documentation

◆ m_amsduSupport

bool ns3::MgtAddBaRequestHeader::m_amsduSupport {true}

private

Flag if A-MSDU is supported.

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

Referenced by GetParameterSet(), IsAmsduSupported(), Print(), SetAmsduSupport(), and SetParameterSet().

◆ m_bufferSize

uint16_t ns3::MgtAddBaRequestHeader::m_bufferSize {0}

private

Buffer size.

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

Referenced by Deserialize(), GetBufferSize(), GetParameterSet(), GetSerializedSize(), Print(), Serialize(), SetBufferSize(), and SetParameterSet().

◆ m_dialogToken

uint8_t ns3::MgtAddBaRequestHeader::m_dialogToken {1}

private

Not used for now.

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

Referenced by Deserialize(), and Serialize().

◆ m_gcrGroupAddress

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

private

GCR Group Address (optional)

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

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

◆ m_policy

uint8_t ns3::MgtAddBaRequestHeader::m_policy {1}

private

Block Ack policy.

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

Referenced by GetParameterSet(), IsImmediateBlockAck(), Print(), SetDelayedBlockAck(), SetImmediateBlockAck(), and SetParameterSet().

◆ m_startingSeq

uint16_t ns3::MgtAddBaRequestHeader::m_startingSeq {0}

private

Starting sequence number.

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

Referenced by GetStartingSequence(), GetStartingSequenceControl(), Print(), SetStartingSequence(), and SetStartingSequenceControl().

◆ m_tid

uint8_t ns3::MgtAddBaRequestHeader::m_tid {0}

private

Traffic ID.

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

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

◆ m_timeoutValue

uint16_t ns3::MgtAddBaRequestHeader::m_timeoutValue {0}

private

Timeout.

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

Referenced by Deserialize(), GetTimeout(), Print(), Serialize(), and SetTimeout().

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()

◆ GetBufferSize()

◆ GetGcrGroupAddress()

◆ GetInstanceTypeId()

◆ GetParameterSet()

◆ GetSerializedSize()

◆ GetStartingSequence()

◆ GetStartingSequenceControl()

◆ GetTid()

◆ GetTimeout()

◆ GetTypeId()

◆ IsAmsduSupported()

◆ IsImmediateBlockAck()

◆ Print()

◆ Serialize()

◆ SetAmsduSupport()

◆ SetBufferSize()

◆ SetDelayedBlockAck()

◆ SetGcrGroupAddress()

◆ SetImmediateBlockAck()

◆ SetParameterSet()

◆ SetStartingSequence()

◆ SetStartingSequenceControl()

◆ SetTid()

◆ SetTimeout()

Member Data Documentation

◆ m_amsduSupport

◆ m_bufferSize

◆ m_dialogToken

◆ m_gcrGroupAddress

◆ m_policy

◆ m_startingSeq

◆ m_tid

◆ m_timeoutValue