Headers for BlockAckRequest. More...

#include "ctrl-headers.h"

Inheritance diagram for ns3::CtrlBAckRequestHeader:

Collaboration diagram for ns3::CtrlBAckRequestHeader:

Public Member Functions
	CtrlBAckRequestHeader ()

	~CtrlBAckRequestHeader () override

uint32_t	Deserialize (Buffer::Iterator start) override

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.

uint16_t	GetStartingSequenceControl () const
	Return the starting sequence control.

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

BlockAckReqType	GetType () const
	Return the BlockAckRequest type.

bool	IsBasic () const
	Check if the current Ack Policy is Basic Block Ack (i.e.

bool	IsCompressed () const
	Check if the current Ack Policy is Compressed Block Ack and not multi-TID.

bool	IsExtendedCompressed () const
	Check if the current Ack Policy is Extended Compressed Block Ack.

bool	IsMultiTid () const
	Check if the current Ack Policy has Multi-TID Block Ack.

bool	MustSendHtImmediateAck () const
	Check if the current Ack Policy is immediate.

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

void	Serialize (Buffer::Iterator start) const override

void	SetHtImmediateAck (bool immediateAck)
	Enable or disable HT immediate Ack.

void	SetStartingSequence (uint16_t seq)
	Set the starting sequence number from the given raw sequence control field.

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

void	SetType (BlockAckReqType type)
	Set the BlockAckRequest type.

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 ()
	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 Member Functions
uint16_t	GetBarControl () const
	Return the Block Ack control.

void	SetBarControl (uint16_t bar)
	Set the Block Ack control.

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

Private Attributes
bool	m_barAckPolicy
	The LSB bit of the BAR control field is used only for the HT (High Throughput) delayed block ack configuration.

BlockAckReqType	m_barType
	BAR type.

uint16_t	m_startingSeq
	starting seq

uint16_t	m_tidInfo
	TID info.

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

Headers for BlockAckRequest.

802.11n standard includes three types of BlockAck:

Basic BlockAck (unique type in 802.11e)
Compressed BlockAck
Multi-TID BlockAck For now only basic BlockAck and compressed BlockAck are supported. Basic BlockAck is also default variant.

Definition at line 40 of file ctrl-headers.h.

Constructor & Destructor Documentation

◆ CtrlBAckRequestHeader()

ns3::CtrlBAckRequestHeader::CtrlBAckRequestHeader ( )

Definition at line 28 of file ctrl-headers.cc.

◆ ~CtrlBAckRequestHeader()

ns3::CtrlBAckRequestHeader::~CtrlBAckRequestHeader ( )

override

Definition at line 34 of file ctrl-headers.cc.

Member Function Documentation

◆ Deserialize()

uint32_t ns3::CtrlBAckRequestHeader::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 104 of file ctrl-headers.cc.

References ns3::BlockAckReqType::BASIC, ns3::BlockAckReqType::COMPRESSED, ns3::BlockAckReqType::EXTENDED_COMPRESSED, ns3::Buffer::Iterator::GetDistanceFrom(), m_barType, ns3::BlockAckReqType::m_variant, ns3::BlockAckReqType::MULTI_TID, NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadLsbtohU16(), SetBarControl(), and SetStartingSequenceControl().

Referenced by ns3::CtrlTriggerUserInfoField::Deserialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBarControl()

uint16_t ns3::CtrlBAckRequestHeader::GetBarControl ( ) const

private

Return the Block Ack control.

Returns: the Block Ack control

Definition at line 126 of file ctrl-headers.cc.

References ns3::BlockAckReqType::BASIC, ns3::BlockAckReqType::COMPRESSED, ns3::BlockAckReqType::EXTENDED_COMPRESSED, m_barType, m_tidInfo, ns3::BlockAckReqType::m_variant, ns3::BlockAckReqType::MULTI_TID, and NS_FATAL_ERROR.

Referenced by Serialize().

Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::CtrlBAckRequestHeader::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 49 of file ctrl-headers.cc.

References GetTypeId().

Here is the call graph for this function:

◆ GetSerializedSize()

uint32_t ns3::CtrlBAckRequestHeader::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 61 of file ctrl-headers.cc.

References ns3::BlockAckReqType::BASIC, ns3::BlockAckReqType::COMPRESSED, ns3::BlockAckReqType::EXTENDED_COMPRESSED, m_barType, m_tidInfo, ns3::BlockAckReqType::m_variant, ns3::BlockAckReqType::MULTI_TID, and NS_FATAL_ERROR.

Referenced by ns3::GetBlockAckRequestSize(), ns3::CtrlTriggerUserInfoField::GetSerializedSize(), and ns3::CtrlTriggerUserInfoField::Serialize().

Here is the caller graph for this function:

◆ GetStartingSequence()

uint16_t ns3::CtrlBAckRequestHeader::GetStartingSequence ( ) const

Return the starting sequence number.

Returns: the starting sequence number

Definition at line 229 of file ctrl-headers.cc.

References m_startingSeq.

Referenced by ns3::HtFrameExchangeManager::GetBar(), ns3::HeFrameExchangeManager::ReceiveMpdu(), and ns3::HtFrameExchangeManager::ReceiveMpdu().

Here is the caller graph for this function:

◆ GetStartingSequenceControl()

uint16_t ns3::CtrlBAckRequestHeader::GetStartingSequenceControl ( ) const

Return the starting sequence control.

Returns: the starting sequence control

Definition at line 174 of file ctrl-headers.cc.

References m_startingSeq.

Referenced by Serialize().

Here is the caller graph for this function:

◆ GetTidInfo()

uint8_t ns3::CtrlBAckRequestHeader::GetTidInfo ( ) const

Return the Traffic ID (TID).

Returns: TID

Definition at line 222 of file ctrl-headers.cc.

References m_tidInfo.

Referenced by ns3::HtFrameExchangeManager::GetBar(), ns3::GetTid(), ns3::HtFrameExchangeManager::MissedBlockAck(), ns3::HeFrameExchangeManager::ReceiveMpdu(), ns3::HtFrameExchangeManager::ReceiveMpdu(), and ns3::BlockAckManager::ScheduleBar().

Here is the caller graph for this function:

◆ GetType()

BlockAckReqType ns3::CtrlBAckRequestHeader::GetType ( ) const

Return the BlockAckRequest type.

Returns: the type of the BlockAckRequest

Definition at line 198 of file ctrl-headers.cc.

References m_barType.

Referenced by ns3::CtrlTriggerUserInfoField::SetMuBarTriggerDepUserInfo().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::CtrlBAckRequestHeader::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 39 of file ctrl-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:

◆ IsBasic()

bool ns3::CtrlBAckRequestHeader::IsBasic ( ) const

Check if the current Ack Policy is Basic Block Ack (i.e.

not multi-TID nor compressed).

Returns: true if the current Ack Policy is Basic Block Ack, false otherwise

Definition at line 235 of file ctrl-headers.cc.

References ns3::BlockAckReqType::BASIC, m_barType, and ns3::BlockAckReqType::m_variant.

◆ IsCompressed()

bool ns3::CtrlBAckRequestHeader::IsCompressed ( ) const

Check if the current Ack Policy is Compressed Block Ack and not multi-TID.

Returns: true if the current Ack Policy is Compressed Block Ack, false otherwise

Definition at line 241 of file ctrl-headers.cc.

References ns3::BlockAckReqType::COMPRESSED, m_barType, and ns3::BlockAckReqType::m_variant.

◆ IsExtendedCompressed()

bool ns3::CtrlBAckRequestHeader::IsExtendedCompressed ( ) const

Check if the current Ack Policy is Extended Compressed Block Ack.

Returns: true if the current Ack Policy is Extended Compressed Block Ack, false otherwise

Definition at line 247 of file ctrl-headers.cc.

References ns3::BlockAckReqType::EXTENDED_COMPRESSED, m_barType, and ns3::BlockAckReqType::m_variant.

◆ IsMultiTid()

bool ns3::CtrlBAckRequestHeader::IsMultiTid ( ) const

Check if the current Ack Policy has Multi-TID Block Ack.

Returns: true if the current Ack Policy has Multi-TID Block Ack, false otherwise

Definition at line 253 of file ctrl-headers.cc.

References m_barType, ns3::BlockAckReqType::m_variant, and ns3::BlockAckReqType::MULTI_TID.

Referenced by ns3::HeFrameExchangeManager::ReceiveMpdu(), and ns3::HtFrameExchangeManager::ReceiveMpdu().

Here is the caller graph for this function:

◆ MustSendHtImmediateAck()

bool ns3::CtrlBAckRequestHeader::MustSendHtImmediateAck ( ) const

Check if the current Ack Policy is immediate.

Returns: true if the current Ack Policy is immediate, false otherwise

Definition at line 216 of file ctrl-headers.cc.

References m_barAckPolicy.

◆ Print()

void ns3::CtrlBAckRequestHeader::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 55 of file ctrl-headers.cc.

References m_startingSeq, and m_tidInfo.

◆ Serialize()

void ns3::CtrlBAckRequestHeader::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 83 of file ctrl-headers.cc.

References ns3::BlockAckReqType::BASIC, ns3::BlockAckReqType::COMPRESSED, ns3::BlockAckReqType::EXTENDED_COMPRESSED, GetBarControl(), GetStartingSequenceControl(), m_barType, ns3::BlockAckReqType::m_variant, ns3::BlockAckReqType::MULTI_TID, NS_FATAL_ERROR, and ns3::Buffer::Iterator::WriteHtolsbU16().

Referenced by ns3::CtrlTriggerUserInfoField::Serialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBarControl()

void ns3::CtrlBAckRequestHeader::SetBarControl ( uint16_t bar )

private

Set the Block Ack control.

Parameters

bar	the BAR control value

Definition at line 151 of file ctrl-headers.cc.

References ns3::BlockAckReqType::BASIC, ns3::BlockAckReqType::COMPRESSED, ns3::BlockAckReqType::EXTENDED_COMPRESSED, m_barAckPolicy, m_barType, m_tidInfo, ns3::BlockAckReqType::m_variant, and ns3::BlockAckReqType::MULTI_TID.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ SetHtImmediateAck()

void ns3::CtrlBAckRequestHeader::SetHtImmediateAck ( bool immediateAck )

Enable or disable HT immediate Ack.

Parameters

immediateAck enable or disable HT immediate Ack

Definition at line 186 of file ctrl-headers.cc.

References m_barAckPolicy.

◆ SetStartingSequence()

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

Set the starting sequence number from the given raw sequence control field.

Parameters

seq	the raw sequence control

Definition at line 210 of file ctrl-headers.cc.

References m_startingSeq.

Referenced by ns3::HtFrameExchangeManager::GetBar(), ns3::BlockAckManager::GetBlockAckReqHeader(), and TestUlOfdmaPowerControl::SendMuBar().

Here is the caller graph for this function:

◆ SetStartingSequenceControl()

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

private

Set the starting sequence control with the given sequence control value.

Parameters

seqControl the sequence control value

Definition at line 180 of file ctrl-headers.cc.

References m_startingSeq.

Referenced by Deserialize().

Here is the caller graph for this function:

◆ SetTidInfo()

void ns3::CtrlBAckRequestHeader::SetTidInfo ( uint8_t tid )

Set Traffic ID (TID).

Parameters

tid the TID

Definition at line 204 of file ctrl-headers.cc.

References m_tidInfo.

Referenced by ns3::BlockAckManager::GetBlockAckReqHeader(), and TestUlOfdmaPowerControl::SendMuBar().

Here is the caller graph for this function:

◆ SetType()

void ns3::CtrlBAckRequestHeader::SetType ( BlockAckReqType type )

Set the BlockAckRequest type.

Parameters

type	the BlockAckRequest type

Definition at line 192 of file ctrl-headers.cc.

References m_barType.

Referenced by ns3::BlockAckManager::GetBlockAckReqHeader(), ns3::GetBlockAckRequestSize(), ns3::GetMuBarSize(), and TestUlOfdmaPowerControl::SendMuBar().

Here is the caller graph for this function:

Member Data Documentation

◆ m_barAckPolicy

bool ns3::CtrlBAckRequestHeader::m_barAckPolicy

private

The LSB bit of the BAR control field is used only for the HT (High Throughput) delayed block ack configuration.

For now only non HT immediate BlockAck is implemented so this field is here only for a future implementation of HT delayed variant. bar ack policy

Definition at line 173 of file ctrl-headers.h.

Referenced by MustSendHtImmediateAck(), SetBarControl(), and SetHtImmediateAck().

◆ m_barType

BlockAckReqType ns3::CtrlBAckRequestHeader::m_barType

private

BAR type.

Definition at line 174 of file ctrl-headers.h.

Referenced by Deserialize(), GetBarControl(), GetSerializedSize(), GetType(), IsBasic(), IsCompressed(), IsExtendedCompressed(), IsMultiTid(), Serialize(), SetBarControl(), and SetType().

◆ m_startingSeq

uint16_t ns3::CtrlBAckRequestHeader::m_startingSeq

private

starting seq

Definition at line 176 of file ctrl-headers.h.

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

◆ m_tidInfo

uint16_t ns3::CtrlBAckRequestHeader::m_tidInfo

private

TID info.

Definition at line 175 of file ctrl-headers.h.

Referenced by GetBarControl(), GetSerializedSize(), GetTidInfo(), Print(), SetBarControl(), and SetTidInfo().

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

src/wifi/model/ctrl-headers.h
src/wifi/model/ctrl-headers.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CtrlBAckRequestHeader()

◆ ~CtrlBAckRequestHeader()

Member Function Documentation

◆ Deserialize()

◆ GetBarControl()

◆ GetInstanceTypeId()

◆ GetSerializedSize()

◆ GetStartingSequence()

◆ GetStartingSequenceControl()

◆ GetTidInfo()

◆ GetType()

◆ GetTypeId()

◆ IsBasic()

◆ IsCompressed()

◆ IsExtendedCompressed()

◆ IsMultiTid()

◆ MustSendHtImmediateAck()

◆ Print()

◆ Serialize()

◆ SetBarControl()

◆ SetHtImmediateAck()

◆ SetStartingSequence()

◆ SetStartingSequenceControl()

◆ SetTidInfo()

◆ SetType()

Member Data Documentation

◆ m_barAckPolicy

◆ m_barType

◆ m_startingSeq

◆ m_tidInfo