A Discrete-Event Network Simulator
API
ns3::CtrlBAckResponseHeader Class Reference

Headers for BlockAck response. More...

#include "ctrl-headers.h"

+ Inheritance diagram for ns3::CtrlBAckResponseHeader:
+ Collaboration diagram for ns3::CtrlBAckResponseHeader:

Classes

struct  BaInfoInstance
 The following structure can hold the BA Information field for the Basic and Compressed variants, one instance of the {Per TID Info, Block Ack Starting Sequence Control, Block Ack Bitmap} subfields for the Multi-TID variant or one instance of the Per AID TID Info subfield for the Multi-STA variant (which includes the AID TID Info, Block Ack Starting Sequence Control and Block Ack Bitmap subfields). More...
 

Public Member Functions

 CtrlBAckResponseHeader ()
 
 ~CtrlBAckResponseHeader ()
 
uint32_t Deserialize (Buffer::Iterator start)
 
std::vector< uint32_tFindPerAidTidInfoWithAid (uint16_t aid) const
 For Multi-STA Block Acks, get the indices of the Per AID TID Info subfields carrying the given AID in the AID11 subfield. More...
 
bool GetAckType (std::size_t index) const
 For Multi-STA Block Acks, get the Ack Type subfield of the Per AID TID Info subfield identified by the given index. More...
 
uint16_t GetAid11 (std::size_t index) const
 For Multi-STA Block Acks, get the AID11 subfield of the Per AID TID Info subfield identified by the given index. More...
 
const std::vector< uint8_t > & GetBitmap (std::size_t index=0) const
 Return a const reference to the bitmap from the BlockAck response header. More...
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
std::size_t GetNPerAidTidInfoSubfields (void) const
 For Multi-STA Block Acks, get the number of Per AID TID Info subfields included in this Block Ack. More...
 
uint32_t GetSerializedSize (void) const
 
uint16_t GetStartingSequence (std::size_t index=0) const
 For Block Ack variants other than Multi-STA Block Ack, get the starting sequence number. More...
 
uint16_t GetStartingSequenceControl (std::size_t index=0) const
 Return the value of the Starting Sequence Control subfield. More...
 
uint8_t GetTidInfo (std::size_t index=0) const
 For Block Ack variants other than Multi-STA Block Ack, get the TID_INFO subfield of the BA Control field. More...
 
BlockAckType GetType (void) const
 Return the block ack type ID. More...
 
Mac48Address GetUnassociatedStaAddress (std::size_t index) const
 For Multi-STA Block Acks, get the RA subfield of the Per AID TID Info subfield (with AID11 subfield equal to 2045) identified by the given index to the given MAC address. More...
 
bool IsBasic (void) const
 Check if the current BA policy is Basic Block Ack. More...
 
bool IsCompressed (void) const
 Check if the current BA policy is Compressed Block Ack. More...
 
bool IsExtendedCompressed (void) const
 Check if the current BA policy is Extended Compressed Block Ack. More...
 
bool IsFragmentReceived (uint16_t seq, uint8_t frag) const
 Check if the packet with the given sequence number and fragment number was acknowledged in this BlockAck response. More...
 
bool IsMultiSta (void) const
 Check if the BlockAck frame variant is Multi-STA Block Ack. More...
 
bool IsMultiTid (void) const
 Check if the current BA policy is Multi-TID Block Ack. More...
 
bool IsPacketReceived (uint16_t seq, std::size_t index=0) const
 Check if the packet with the given sequence number was acknowledged in this BlockAck response. More...
 
bool MustSendHtImmediateAck (void) const
 Check if the current Ack Policy is immediate. More...
 
void Print (std::ostream &os) const
 
void ResetBitmap (std::size_t index=0)
 Reset the bitmap to 0. More...
 
void Serialize (Buffer::Iterator start) const
 
void SetAckType (bool type, std::size_t index)
 For Multi-STA Block Acks, set the Ack Type subfield of the Per AID TID Info subfield identified by the given index to the given value. More...
 
void SetAid11 (uint16_t aid, std::size_t index)
 For Multi-STA Block Acks, set the AID11 subfield of the Per AID TID Info subfield identified by the given index to the given value. More...
 
void SetHtImmediateAck (bool immediateAck)
 Enable or disable HT immediate Ack. More...
 
void SetReceivedFragment (uint16_t seq, uint8_t frag)
 Set the bitmap that the packet with the given sequence number and fragment number was received. More...
 
void SetReceivedPacket (uint16_t seq, std::size_t index=0)
 Record in the bitmap that the packet with the given sequence number was received. More...
 
void SetStartingSequence (uint16_t seq, std::size_t index=0)
 For Block Ack variants other than Multi-STA Block Ack, set the starting sequence number to the given value. More...
 
void SetStartingSequenceControl (uint16_t seqControl, std::size_t index=0)
 Set the Starting Sequence Control subfield with the given sequence control value. More...
 
void SetTidInfo (uint8_t tid, std::size_t index=0)
 For Block Ack variants other than Multi-STA Block Ack, set the TID_INFO subfield of the BA Control field. More...
 
void SetType (BlockAckType type)
 Set the block ack type. More...
 
void SetUnassociatedStaAddress (const Mac48Address &ra, std::size_t index)
 For Multi-STA Block Acks, set the RA subfield of the Per AID TID Info subfield (with AID11 subfield equal to 2045) identified by the given index to the given MAC address. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t GetSerializedSize (void) const =0
 
virtual void Print (std::ostream &os) const =0
 
virtual void Serialize (Buffer::Iterator start) const =0
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual void Print (std::ostream &os) const =0
 Print the object contents. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Member Functions

Buffer::Iterator DeserializeBitmap (Buffer::Iterator start, std::size_t index=0)
 Deserialize bitmap from the given buffer. More...
 
uint16_t GetBaControl (void) const
 Return the Block Ack control. More...
 
uint16_t IndexInBitmap (uint16_t seq, std::size_t index=0) const
 This function is used to correctly index in both bitmap and compressed bitmap, one bit or one block of 16 bits respectively. More...
 
bool IsInBitmap (uint16_t seq, std::size_t index=0) const
 Check if sequence number seq can be acknowledged in the bitmap. More...
 
Buffer::Iterator SerializeBitmap (Buffer::Iterator start, std::size_t index=0) const
 Serialize bitmap to the given buffer. More...
 
void SetBaControl (uint16_t ba)
 Set the Block Ack control. More...
 

Private Attributes

bool m_baAckPolicy
 The LSB bit of the BA control field is used only for the HT (High Throughput) delayed block ack configuration. More...
 
std::vector< BaInfoInstancem_baInfo
 BA Information field. More...
 
BlockAckType m_baType
 BA type. More...
 
uint16_t m_tidInfo
 TID info (reserved if Multi-STA Block Ack) More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Headers for BlockAck response.

Introspection did not find any typical Config paths.

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.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 80 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ CtrlBAckResponseHeader()

ns3::CtrlBAckResponseHeader::CtrlBAckResponseHeader ( )

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

References ns3::BlockAckType::BASIC, and SetType().

+ Here is the call graph for this function:

◆ ~CtrlBAckResponseHeader()

ns3::CtrlBAckResponseHeader::~CtrlBAckResponseHeader ( )

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

Member Function Documentation

◆ Deserialize()

uint32_t ns3::CtrlBAckResponseHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan 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 394 of file ctrl-headers.cc.

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, DeserializeBitmap(), ns3::BlockAckType::EXTENDED_COMPRESSED, GetAckType(), GetAid11(), ns3::Buffer::Iterator::GetDistanceFrom(), ns3::Buffer::Iterator::GetRemainingSize(), GetTidInfo(), m_baInfo, m_baType, ns3::BlockAckType::m_bitmapLen, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_FATAL_ERROR, ns3::ReadFrom(), ns3::Buffer::Iterator::ReadLsbtohU16(), ns3::Buffer::Iterator::ReadLsbtohU32(), SetBaControl(), SetStartingSequenceControl(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ DeserializeBitmap()

Buffer::Iterator ns3::CtrlBAckResponseHeader::DeserializeBitmap ( Buffer::Iterator  start,
std::size_t  index = 0 
)
private

Deserialize bitmap from the given buffer.

For Multi-STA Block Acks, index identifies the Per AID TID Info subfield whose bitmap has to be deserialized.

Parameters
startiterator pointing to the beginning of the buffer to read from.
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
Buffer::Iterator to the next available buffer

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

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baInfo, m_baType, ns3::BlockAckType::m_bitmapLen, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_ASSERT, NS_ASSERT_MSG, NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadU8(), and visualizer.core::start().

Referenced by Deserialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ FindPerAidTidInfoWithAid()

std::vector< uint32_t > ns3::CtrlBAckResponseHeader::FindPerAidTidInfoWithAid ( uint16_t  aid) const

For Multi-STA Block Acks, get the indices of the Per AID TID Info subfields carrying the given AID in the AID11 subfield.

Parameters
aidthe given AID
Returns
a vector containing the indices of the Per AID TID Info subfields carrying the given AID in the AID11 subfield

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

References GetAid11(), m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, and NS_ASSERT.

Referenced by ns3::HeFrameExchangeManager::ReceiveMpdu().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetAckType()

bool ns3::CtrlBAckResponseHeader::GetAckType ( std::size_t  index) const

For Multi-STA Block Acks, get the Ack Type subfield of the Per AID TID Info subfield identified by the given index.

Parameters
indexthe index of the Per AID TID Info subfield
Returns
the Ack Type

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

References m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, and NS_ASSERT.

Referenced by OfdmaAckSequenceTest::CheckResults(), Deserialize(), MultiStaCtrlBAckResponseHeaderTest::DoRun(), IsPacketReceived(), ns3::BlockAckManager::NotifyGotBlockAck(), and ns3::HeFrameExchangeManager::ReceiveMpdu().

+ Here is the caller graph for this function:

◆ GetAid11()

uint16_t ns3::CtrlBAckResponseHeader::GetAid11 ( std::size_t  index) const

For Multi-STA Block Acks, get the AID11 subfield of the Per AID TID Info subfield identified by the given index.

Parameters
indexthe index of the Per AID TID Info subfield
Returns
the AID11 subfield

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

References m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, and NS_ASSERT.

Referenced by Deserialize(), MultiStaCtrlBAckResponseHeaderTest::DoRun(), FindPerAidTidInfoWithAid(), GetUnassociatedStaAddress(), Print(), Serialize(), and SetUnassociatedStaAddress().

+ Here is the caller graph for this function:

◆ GetBaControl()

uint16_t ns3::CtrlBAckResponseHeader::GetBaControl ( void  ) const
private

Return the Block Ack control.

Returns
the Block Ack control

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

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baAckPolicy, m_baType, m_tidInfo, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, and NS_FATAL_ERROR.

Referenced by Serialize().

+ Here is the caller graph for this function:

◆ GetBitmap()

const std::vector< uint8_t > & ns3::CtrlBAckResponseHeader::GetBitmap ( std::size_t  index = 0) const

Return a const reference to the bitmap from the BlockAck response header.

For Multi-STA Block Acks, return a const reference to the bitmap included in the Per AID TID Info subfield identified by index.

Parameters
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
a const reference to the bitmap from the BlockAck response header

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

References m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, and NS_ASSERT_MSG.

Referenced by MultiStaCtrlBAckResponseHeaderTest::DoRun(), CtrlBAckResponseHeaderTest::DoRun(), and ns3::HeFrameExchangeManager::ReceiveMpdu().

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

TypeId ns3::CtrlBAckResponseHeader::GetInstanceTypeId ( void  ) const
virtual

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 298 of file ctrl-headers.cc.

References GetTypeId().

+ Here is the call graph for this function:

◆ GetNPerAidTidInfoSubfields()

std::size_t ns3::CtrlBAckResponseHeader::GetNPerAidTidInfoSubfields ( void  ) const

For Multi-STA Block Acks, get the number of Per AID TID Info subfields included in this Block Ack.

Returns
the number of Per AID TID Info subfields included in this Multi-STA Block Ack

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

References m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, and NS_ASSERT.

Referenced by OfdmaAckSequenceTest::CheckResults().

+ Here is the caller graph for this function:

◆ GetSerializedSize()

uint32_t ns3::CtrlBAckResponseHeader::GetSerializedSize ( void  ) const
virtual
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 322 of file ctrl-headers.cc.

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baType, ns3::BlockAckType::m_bitmapLen, m_tidInfo, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, and NS_FATAL_ERROR.

Referenced by ns3::GetBlockAckSize().

+ Here is the caller graph for this function:

◆ GetStartingSequence()

uint16_t ns3::CtrlBAckResponseHeader::GetStartingSequence ( std::size_t  index = 0) const

For Block Ack variants other than Multi-STA Block Ack, get the starting sequence number.

For Multi-STA Block Acks, get the starting sequence number in the Per AID TID Info subfield identified by the given index.

Parameters
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
the starting sequence number

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

References m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, and NS_ASSERT_MSG.

Referenced by MultiStaCtrlBAckResponseHeaderTest::DoRun(), and ns3::HeFrameExchangeManager::SendMultiStaBlockAck().

+ Here is the caller graph for this function:

◆ GetStartingSequenceControl()

uint16_t ns3::CtrlBAckResponseHeader::GetStartingSequenceControl ( std::size_t  index = 0) const

Return the value of the Starting Sequence Control subfield.

For Multi-STA Block Acks, index identifies the Per AID TID Info subfield whose Starting Sequence Control subfield has to be returned.

Parameters
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
the value of the Starting Sequence Control subfield

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

References ns3::BlockAckType::COMPRESSED, m_baInfo, m_baType, ns3::BlockAckType::m_bitmapLen, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, and NS_ASSERT_MSG.

Referenced by Serialize().

+ Here is the caller graph for this function:

◆ GetTidInfo()

uint8_t ns3::CtrlBAckResponseHeader::GetTidInfo ( std::size_t  index = 0) const

For Block Ack variants other than Multi-STA Block Ack, get the TID_INFO subfield of the BA Control field.

For Multi-STA Block Acks, get the TID subfield of the AID TID Info subfield of the Per AID TID Info subfield identified by the given index.

Parameters
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
the Traffic ID

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

References m_baInfo, m_baType, m_tidInfo, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, and NS_ASSERT_MSG.

Referenced by OfdmaAckSequenceTest::CheckResults(), Deserialize(), MultiStaCtrlBAckResponseHeaderTest::DoRun(), ns3::GetTid(), IsPacketReceived(), ns3::BlockAckManager::NotifyGotBlockAck(), Print(), ns3::HeFrameExchangeManager::ReceiveMpdu(), and ns3::HtFrameExchangeManager::ReceiveMpdu().

+ Here is the caller graph for this function:

◆ GetType()

BlockAckType ns3::CtrlBAckResponseHeader::GetType ( void  ) const

Return the block ack type ID.

Returns
type

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

References m_baType.

Referenced by MultiStaCtrlBAckResponseHeaderTest::DoRun().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::CtrlBAckResponseHeader::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

◆ GetUnassociatedStaAddress()

Mac48Address ns3::CtrlBAckResponseHeader::GetUnassociatedStaAddress ( std::size_t  index) const

For Multi-STA Block Acks, get the RA subfield of the Per AID TID Info subfield (with AID11 subfield equal to 2045) identified by the given index to the given MAC address.

Parameters
indexthe index of the Per AID TID Info subfield
Returns
the MAC address stored in the RA subfield

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

References GetAid11(), m_baInfo, and NS_ASSERT.

Referenced by MultiStaCtrlBAckResponseHeaderTest::DoRun().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ IndexInBitmap()

uint16_t ns3::CtrlBAckResponseHeader::IndexInBitmap ( uint16_t  seq,
std::size_t  index = 0 
) const
private

This function is used to correctly index in both bitmap and compressed bitmap, one bit or one block of 16 bits respectively.

for more details see 7.2.1.8 in IEEE 802.11n/D4.00

Parameters
seqthe sequence number
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
If we are using basic block ack, return value represents index of block of 16 bits for packet having sequence number equals to seq. If we are using compressed block ack, return value represents bit to set to 1 in the compressed bitmap to indicate that packet having sequence number equals to seq was correctly received.

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

References ns3::BlockAckType::BASIC, m_baInfo, m_baType, ns3::BlockAckType::m_bitmapLen, ns3::BlockAckType::m_variant, NS_ASSERT, and ns3::SEQNO_SPACE_SIZE.

Referenced by IsFragmentReceived(), IsPacketReceived(), SetReceivedFragment(), and SetReceivedPacket().

+ Here is the caller graph for this function:

◆ IsBasic()

bool ns3::CtrlBAckResponseHeader::IsBasic ( void  ) const

Check if the current BA policy is Basic Block Ack.

Returns
true if the current BA policy is Basic Block Ack, false otherwise

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

References ns3::BlockAckType::BASIC, m_baType, and ns3::BlockAckType::m_variant.

Referenced by ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), and ns3::BlockAckManager::NotifyGotBlockAck().

+ Here is the caller graph for this function:

◆ IsCompressed()

bool ns3::CtrlBAckResponseHeader::IsCompressed ( void  ) const

Check if the current BA policy is Compressed Block Ack.

Returns
true if the current BA policy is Compressed Block Ack, false otherwise

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

References ns3::BlockAckType::COMPRESSED, m_baType, and ns3::BlockAckType::m_variant.

Referenced by ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), and ns3::BlockAckManager::NotifyGotBlockAck().

+ Here is the caller graph for this function:

◆ IsExtendedCompressed()

bool ns3::CtrlBAckResponseHeader::IsExtendedCompressed ( void  ) const

Check if the current BA policy is Extended Compressed Block Ack.

Returns
true if the current BA policy is Extended Compressed Block Ack, false otherwise

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

References ns3::BlockAckType::EXTENDED_COMPRESSED, m_baType, and ns3::BlockAckType::m_variant.

Referenced by ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), and ns3::BlockAckManager::NotifyGotBlockAck().

+ Here is the caller graph for this function:

◆ IsFragmentReceived()

bool ns3::CtrlBAckResponseHeader::IsFragmentReceived ( uint16_t  seq,
uint8_t  frag 
) const

Check if the packet with the given sequence number and fragment number was acknowledged in this BlockAck response.

Parameters
seqthe sequence number
fragthe fragment number
Returns
true if the packet with the given sequence number and sequence number was acknowledged in this BlockAck response, false otherwise

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

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, IndexInBitmap(), IsInBitmap(), m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_ASSERT, and NS_FATAL_ERROR.

+ Here is the call graph for this function:

◆ IsInBitmap()

bool ns3::CtrlBAckResponseHeader::IsInBitmap ( uint16_t  seq,
std::size_t  index = 0 
) const
private

Check if sequence number seq can be acknowledged in the bitmap.

For Multi-STA Block Acks, check if sequence number seq can be acknowledged in the bitmap included in the Per AID TID Info subfield identified by index.

Parameters
seqthe sequence number
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
true if the sequence number is concerned by the bitmap

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

References ns3::BlockAckType::BASIC, m_baInfo, m_baType, ns3::BlockAckType::m_bitmapLen, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, NS_ASSERT_MSG, and ns3::SEQNO_SPACE_SIZE.

Referenced by IsFragmentReceived(), IsPacketReceived(), SetReceivedFragment(), and SetReceivedPacket().

+ Here is the caller graph for this function:

◆ IsMultiSta()

bool ns3::CtrlBAckResponseHeader::IsMultiSta ( void  ) const

Check if the BlockAck frame variant is Multi-STA Block Ack.

Returns
true if the BlockAck frame variant is Multi-STA Block Ack, false otherwise

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

References m_baType, ns3::BlockAckType::m_variant, and ns3::BlockAckType::MULTI_STA.

Referenced by OfdmaAckSequenceTest::CheckResults(), ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), ns3::BlockAckManager::NotifyGotBlockAck(), ns3::HeFrameExchangeManager::ReceiveMpdu(), and OfdmaAckSequenceTest::Transmit().

+ Here is the caller graph for this function:

◆ IsMultiTid()

bool ns3::CtrlBAckResponseHeader::IsMultiTid ( void  ) const

Check if the current BA policy is Multi-TID Block Ack.

Returns
true if the current BA policy is Multi-TID Block Ack, false otherwise

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

References m_baType, ns3::BlockAckType::m_variant, and ns3::BlockAckType::MULTI_TID.

Referenced by ns3::RecipientBlockAckAgreement::FillBlockAckBitmap(), and ns3::BlockAckManager::NotifyGotBlockAck().

+ Here is the caller graph for this function:

◆ IsPacketReceived()

bool ns3::CtrlBAckResponseHeader::IsPacketReceived ( uint16_t  seq,
std::size_t  index = 0 
) const

Check if the packet with the given sequence number was acknowledged in this BlockAck response.

For Multi-STA Block Acks, index identifies the Per AID TID Info subfield whose bitmap has to be checked.

Parameters
seqthe sequence number to be checked
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
true if the packet with the given sequence number was ACKed in this BlockAck response, false otherwise

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

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, GetAckType(), GetTidInfo(), IndexInBitmap(), IsInBitmap(), m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_ASSERT, NS_ASSERT_MSG, and NS_FATAL_ERROR.

Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::BlockAckManager::NotifyGotBlockAck().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ MustSendHtImmediateAck()

bool ns3::CtrlBAckResponseHeader::MustSendHtImmediateAck ( void  ) const

Check if the current Ack Policy is immediate.

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

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

References m_baAckPolicy.

◆ Print()

void ns3::CtrlBAckResponseHeader::Print ( std::ostream &  os) const
virtual
Parameters
osoutput 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 304 of file ctrl-headers.cc.

References GetAid11(), GetTidInfo(), m_baInfo, m_baType, m_tidInfo, ns3::BlockAckType::m_variant, and ns3::BlockAckType::MULTI_STA.

+ Here is the call graph for this function:

◆ ResetBitmap()

void ns3::CtrlBAckResponseHeader::ResetBitmap ( std::size_t  index = 0)

Reset the bitmap to 0.

For Multi-STA Block Acks, reset the bitmap included in the Per AID TID Info subfield identified by index.

Parameters
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)

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

References m_baInfo, m_baType, ns3::BlockAckType::m_bitmapLen, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, and NS_ASSERT_MSG.

Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::RecipientBlockAckAgreement::FillBlockAckBitmap().

+ Here is the caller graph for this function:

◆ Serialize()

void ns3::CtrlBAckResponseHeader::Serialize ( Buffer::Iterator  start) const
virtual
Parameters
startan 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 352 of file ctrl-headers.cc.

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, GetAid11(), GetBaControl(), GetStartingSequenceControl(), m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_FATAL_ERROR, SerializeBitmap(), visualizer.core::start(), ns3::Buffer::Iterator::WriteHtolsbU16(), ns3::Buffer::Iterator::WriteHtolsbU32(), and ns3::WriteTo().

+ Here is the call graph for this function:

◆ SerializeBitmap()

Buffer::Iterator ns3::CtrlBAckResponseHeader::SerializeBitmap ( Buffer::Iterator  start,
std::size_t  index = 0 
) const
private

Serialize bitmap to the given buffer.

For Multi-STA Block Acks, index identifies the Per AID TID Info subfield whose bitmap has to be serialized.

Parameters
startiterator pointing to the beginning of the buffer to write into.
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)
Returns
Buffer::Iterator to the next available buffer

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

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_ASSERT, NS_ASSERT_MSG, NS_FATAL_ERROR, visualizer.core::start(), and ns3::Buffer::Iterator::WriteU8().

Referenced by Serialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetAckType()

void ns3::CtrlBAckResponseHeader::SetAckType ( bool  type,
std::size_t  index 
)

For Multi-STA Block Acks, set the Ack Type subfield of the Per AID TID Info subfield identified by the given index to the given value.

Parameters
typethe ack type value
indexthe index of the Per AID TID Info subfield

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

References m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, and trim-trailing-whitespace::type.

Referenced by ns3::HeFrameExchangeManager::SendMultiStaBlockAck().

+ Here is the caller graph for this function:

◆ SetAid11()

void ns3::CtrlBAckResponseHeader::SetAid11 ( uint16_t  aid,
std::size_t  index 
)

For Multi-STA Block Acks, set the AID11 subfield of the Per AID TID Info subfield identified by the given index to the given value.

Parameters
aidthe AID11 value
indexthe index of the Per AID TID Info subfield

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

References m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, and NS_ASSERT.

Referenced by ns3::HeFrameExchangeManager::SendMultiStaBlockAck().

+ Here is the caller graph for this function:

◆ SetBaControl()

void ns3::CtrlBAckResponseHeader::SetBaControl ( uint16_t  ba)
private

Set the Block Ack control.

Parameters
bathe BA control to set

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

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, m_baAckPolicy, m_baType, m_tidInfo, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_FATAL_ERROR, and SetType().

Referenced by Deserialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetHtImmediateAck()

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

Enable or disable HT immediate Ack.

Parameters
immediateAckenable or disable HT immediate Ack

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

References m_baAckPolicy.

◆ SetReceivedFragment()

void ns3::CtrlBAckResponseHeader::SetReceivedFragment ( uint16_t  seq,
uint8_t  frag 
)

Set the bitmap that the packet with the given sequence number and fragment number was received.

Parameters
seqthe sequence number
fragthe fragment number

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

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, IndexInBitmap(), IsInBitmap(), m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_ASSERT, and NS_FATAL_ERROR.

+ Here is the call graph for this function:

◆ SetReceivedPacket()

void ns3::CtrlBAckResponseHeader::SetReceivedPacket ( uint16_t  seq,
std::size_t  index = 0 
)

Record in the bitmap that the packet with the given sequence number was received.

For Multi-STA Block Acks, index identifies the Per AID TID Info subfield whose bitmap has to be updated.

Parameters
seqthe sequence number of the received packet
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)

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

References ns3::BlockAckType::BASIC, ns3::BlockAckType::COMPRESSED, ns3::BlockAckType::EXTENDED_COMPRESSED, IndexInBitmap(), IsInBitmap(), m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, ns3::BlockAckType::MULTI_TID, NS_ASSERT, NS_ASSERT_MSG, and NS_FATAL_ERROR.

Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::RecipientBlockAckAgreement::FillBlockAckBitmap().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetStartingSequence()

void ns3::CtrlBAckResponseHeader::SetStartingSequence ( uint16_t  seq,
std::size_t  index = 0 
)

For Block Ack variants other than Multi-STA Block Ack, set the starting sequence number to the given value.

For Multi-STA Block Acks, set the starting sequence number in the Per AID TID Info subfield identified by the given index to the given value.

Parameters
seqthe starting sequence number
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)

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

References m_baInfo, m_baType, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, and NS_ASSERT_MSG.

Referenced by CtrlBAckResponseHeaderTest::DoRun(), and ns3::RecipientBlockAckAgreement::FillBlockAckBitmap().

+ Here is the caller graph for this function:

◆ SetStartingSequenceControl()

void ns3::CtrlBAckResponseHeader::SetStartingSequenceControl ( uint16_t  seqControl,
std::size_t  index = 0 
)

Set the Starting Sequence Control subfield with the given sequence control value.

For Multi-STA Block Acks, index identifies the Per AID TID Info subfield whose Starting Sequence Control subfield has to be set.

Parameters
seqControlthe raw sequence control value
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)

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

References ns3::BlockAckType::COMPRESSED, m_baInfo, m_baType, ns3::BlockAckType::m_bitmapLen, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, NS_ASSERT_MSG, NS_FATAL_ERROR, and SetType().

Referenced by Deserialize().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetTidInfo()

void ns3::CtrlBAckResponseHeader::SetTidInfo ( uint8_t  tid,
std::size_t  index = 0 
)

For Block Ack variants other than Multi-STA Block Ack, set the TID_INFO subfield of the BA Control field.

For Multi-STA Block Acks, set the TID subfield of the AID TID Info subfield of the Per AID TID Info subfield identified by the given index.

Parameters
tidthe traffic ID
indexthe index of the Per AID TID Info subfield (Multi-STA Block Ack only)

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

References m_baInfo, m_baType, m_tidInfo, ns3::BlockAckType::m_variant, ns3::BlockAckType::MULTI_STA, NS_ASSERT, and NS_ASSERT_MSG.

Referenced by ns3::HtFrameExchangeManager::SendBlockAck(), and ns3::HeFrameExchangeManager::SendMultiStaBlockAck().

+ Here is the caller graph for this function:

◆ SetType()

◆ SetUnassociatedStaAddress()

void ns3::CtrlBAckResponseHeader::SetUnassociatedStaAddress ( const Mac48Address ra,
std::size_t  index 
)

For Multi-STA Block Acks, set the RA subfield of the Per AID TID Info subfield (with AID11 subfield equal to 2045) identified by the given index to the given MAC address.

Parameters
rathe MAC address
indexthe index of the Per AID TID Info subfield

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

References GetAid11(), m_baInfo, and NS_ASSERT.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_baAckPolicy

bool ns3::CtrlBAckResponseHeader::m_baAckPolicy
private

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

For now only non HT immediate block ack is implemented so this field is here only for a future implementation of HT delayed variant. BA Ack Policy

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

Referenced by GetBaControl(), MustSendHtImmediateAck(), SetBaControl(), and SetHtImmediateAck().

◆ m_baInfo

◆ m_baType

◆ m_tidInfo

uint16_t ns3::CtrlBAckResponseHeader::m_tidInfo
private

TID info (reserved if Multi-STA Block Ack)

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

Referenced by GetBaControl(), GetSerializedSize(), GetTidInfo(), Print(), SetBaControl(), and SetTidInfo().


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