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

Headers for Block ack request. More...

#include "ctrl-headers.h"

+ Inheritance diagram for ns3::CtrlBAckRequestHeader:
+ Collaboration diagram for ns3::CtrlBAckRequestHeader:

Public Member Functions

 CtrlBAckRequestHeader ()
 
 ~CtrlBAckRequestHeader ()
 
uint32_t Deserialize (Buffer::Iterator start)
 
TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
uint32_t GetSerializedSize (void) const
 
uint16_t GetStartingSequence (void) const
 Return the starting sequence number. More...
 
uint16_t GetStartingSequenceControl (void) const
 Return the starting sequence control. More...
 
uint8_t GetTidInfo (void) const
 Return the Traffic ID (TID). More...
 
BlockAckType GetType (void) const
 Return the block ACK type ID. More...
 
bool IsBasic (void) const
 Check if the current ACK policy is basic (i.e. More...
 
bool IsCompressed (void) const
 Check if the current ACK policy is compressed ACK and not multiple TID. More...
 
bool IsExtendedCompressed (void) const
 Check if the current BA policy is extended compressed block ACK. More...
 
bool IsMultiTid (void) const
 Check if the current ACK policy has multiple TID. More...
 
bool MustSendHtImmediateAck (void) const
 Check if the current ACK policy is immediate. More...
 
void Print (std::ostream &os) const
 
void Serialize (Buffer::Iterator start) const
 
void SetHtImmediateAck (bool immediateAck)
 Enable or disable HT immediate ACK. More...
 
void SetStartingSequence (uint16_t seq)
 Set the starting sequence number from the given raw sequence control field. More...
 
void SetTidInfo (uint8_t tid)
 Set Traffic ID (TID). More...
 
void SetType (BlockAckType type)
 Set the block ACK type. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. More...
 
virtual uint32_t Deserialize (Buffer::Iterator start)=0
 Deserialize the object from a buffer iterator. More...
 
- Public Member Functions inherited from ns3::Chunk
virtual uint32_t Deserialize (Buffer::Iterator start, Buffer::Iterator end)
 Deserialize the object from a buffer iterator. 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...
 
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

uint16_t GetBarControl (void) const
 Return the Block ACK control. More...
 
void SetBarControl (uint16_t bar)
 Set the Block ACK control. More...
 
void SetStartingSequenceControl (uint16_t seqControl)
 Set the starting sequence control with the given sequence control value. More...
 

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. More...
 
BlockAckType m_baType
 BA type. More...
 
uint16_t m_startingSeq
 starting seq More...
 
uint16_t m_tidInfo
 TID info. 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 Block ack request.


Introspection did not find any typical Config paths.

802.11n standard includes three types of block ack:

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


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

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

Constructor & Destructor Documentation

◆ CtrlBAckRequestHeader()

ns3::CtrlBAckRequestHeader::CtrlBAckRequestHeader ( )

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

◆ ~CtrlBAckRequestHeader()

ns3::CtrlBAckRequestHeader::~CtrlBAckRequestHeader ( )

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

Member Function Documentation

◆ Deserialize()

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

References ns3::BASIC_BLOCK_ACK, ns3::COMPRESSED_BLOCK_ACK, ns3::EXTENDED_COMPRESSED_BLOCK_ACK, ns3::Buffer::Iterator::GetDistanceFrom(), m_baType, ns3::MULTI_TID_BLOCK_ACK, NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadLsbtohU16(), SetBarControl(), SetStartingSequenceControl(), and visualizer.core::start().

+ Here is the call graph for this function:

◆ GetBarControl()

uint16_t ns3::CtrlBAckRequestHeader::GetBarControl ( void  ) const
private

Return the Block ACK control.

Returns
the Block ACK control

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

References ns3::BASIC_BLOCK_ACK, ns3::COMPRESSED_BLOCK_ACK, ns3::EXTENDED_COMPRESSED_BLOCK_ACK, m_baType, m_tidInfo, ns3::MULTI_TID_BLOCK_ACK, and NS_FATAL_ERROR.

Referenced by Serialize().

+ Here is the caller graph for this function:

◆ GetInstanceTypeId()

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

References GetTypeId().

+ Here is the call graph for this function:

◆ GetSerializedSize()

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

References ns3::BASIC_BLOCK_ACK, ns3::COMPRESSED_BLOCK_ACK, ns3::EXTENDED_COMPRESSED_BLOCK_ACK, m_baType, m_tidInfo, ns3::MULTI_TID_BLOCK_ACK, and NS_FATAL_ERROR.

Referenced by ns3::GetBlockAckRequestSize().

+ Here is the caller graph for this function:

◆ GetStartingSequence()

uint16_t ns3::CtrlBAckRequestHeader::GetStartingSequence ( void  ) const

Return the starting sequence number.

Returns
the starting sequence number

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

References m_startingSeq.

Referenced by ns3::MacLow::ReceiveOk(), and ns3::MacLow::SendBlockAckAfterBlockAckRequest().

+ Here is the caller graph for this function:

◆ GetStartingSequenceControl()

uint16_t ns3::CtrlBAckRequestHeader::GetStartingSequenceControl ( void  ) const

Return the starting sequence control.

Returns
the starting sequence control

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

References m_startingSeq.

Referenced by ns3::MacLow::SendBlockAckAfterBlockAckRequest(), and Serialize().

+ Here is the caller graph for this function:

◆ GetTidInfo()

uint8_t ns3::CtrlBAckRequestHeader::GetTidInfo ( void  ) const

Return the Traffic ID (TID).

Returns
TID

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

References m_tidInfo.

Referenced by ns3::GetTid(), ns3::QosTxop::GetTransmissionParameters(), ns3::QosTxop::NeedBarRetransmission(), ns3::MacLow::ReceiveOk(), and ns3::MacLow::SendBlockAckAfterBlockAckRequest().

+ Here is the caller graph for this function:

◆ GetType()

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

Return the block ACK type ID.

Returns
type

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

References m_baType.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 43 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 ( void  ) const

Check if the current ACK policy is basic (i.e.

not multiple TID and not compressed ACK).

Returns
true if the current ACK policy is basic, false otherwise

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

References ns3::BASIC_BLOCK_ACK, and m_baType.

Referenced by ns3::MacLow::SendBlockAckAfterBlockAckRequest().

+ Here is the caller graph for this function:

◆ IsCompressed()

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

Check if the current ACK policy is compressed ACK and not multiple TID.

Returns
true if the current ACK policy is compressed ACK, false otherwise

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

References ns3::COMPRESSED_BLOCK_ACK, and m_baType.

Referenced by ns3::MacLow::SendBlockAckAfterBlockAckRequest().

+ Here is the caller graph for this function:

◆ IsExtendedCompressed()

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

References ns3::EXTENDED_COMPRESSED_BLOCK_ACK, and m_baType.

Referenced by ns3::MacLow::SendBlockAckAfterBlockAckRequest().

+ Here is the caller graph for this function:

◆ IsMultiTid()

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

Check if the current ACK policy has multiple TID.

Returns
true if the current ACK policy has multiple TID, false otherwise

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

References m_baType, and ns3::MULTI_TID_BLOCK_ACK.

Referenced by ns3::MacLow::ReceiveOk(), and ns3::MacLow::SendBlockAckAfterBlockAckRequest().

+ Here is the caller graph for this function:

◆ MustSendHtImmediateAck()

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

References m_barAckPolicy.

◆ Print()

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

References m_startingSeq, and m_tidInfo.

◆ Serialize()

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

References ns3::BASIC_BLOCK_ACK, ns3::COMPRESSED_BLOCK_ACK, ns3::EXTENDED_COMPRESSED_BLOCK_ACK, GetBarControl(), GetStartingSequenceControl(), m_baType, ns3::MULTI_TID_BLOCK_ACK, NS_FATAL_ERROR, visualizer.core::start(), and ns3::Buffer::Iterator::WriteHtolsbU16().

+ Here is the call graph for this function:

◆ SetBarControl()

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

Set the Block ACK control.

Parameters
bar

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

References ns3::BASIC_BLOCK_ACK, ns3::COMPRESSED_BLOCK_ACK, ns3::EXTENDED_COMPRESSED_BLOCK_ACK, m_barAckPolicy, m_baType, m_tidInfo, and ns3::MULTI_TID_BLOCK_ACK.

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
immediateAckenable or disable HT immediate ACK

Definition at line 191 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
seqthe raw sequence control

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

References m_startingSeq.

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

+ 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

Definition at line 185 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

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

References m_tidInfo.

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

+ Here is the caller graph for this function:

◆ SetType()

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

Set the block ACK type.

Parameters
type

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

References m_baType.

Referenced by ns3::GetBlockAckRequestSize(), and ns3::BlockAckManager::ScheduleBlockAckReq().

+ 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 block ack is implemented so this field is here only for a future implementation of HT delayed variant.bar ack policy

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

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

◆ m_baType

BlockAckType ns3::CtrlBAckRequestHeader::m_baType
private

◆ m_startingSeq

uint16_t ns3::CtrlBAckRequestHeader::m_startingSeq
private

◆ m_tidInfo

uint16_t ns3::CtrlBAckRequestHeader::m_tidInfo
private

TID info.

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