A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 ()
virtual uint32_t Deserialize (Buffer::Iterator start)
virtual TypeId GetInstanceTypeId (void) const
virtual uint32_t GetSerializedSize (void) const
uint16_t GetStartingSequence (void) const
uint16_t GetStartingSequenceControl (void) const
uint8_t GetTidInfo (void) const
bool IsBasic (void) const
bool IsCompressed (void) const
bool IsMultiTid (void) const
bool MustSendHtImmediateAck (void) const
virtual void Print (std::ostream &os) const
virtual void Serialize (Buffer::Iterator start) const
void SetHtImmediateAck (bool immediateAck)
void SetStartingSequence (uint16_t seq)
void SetTidInfo (uint8_t tid)
void SetType (enum BlockAckType type)
- Public Member Functions inherited from ns3::Header
virtual ~Header ()

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::CtrlBAckRequestHeader.

Private Member Functions

uint16_t GetBarControl (void) const
void SetBarControl (uint16_t bar)
void SetStartingSequenceControl (uint16_t seqControl)

Private Attributes

bool m_barAckPolicy
bool m_compressed
bool m_multiTid
uint16_t m_startingSeq
uint16_t m_tidInfo

Additional Inherited Members

- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
virtual void NotifyConstructionCompleted (void)

Detailed Description

Headers for Block ack request.

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.

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

Constructor & Destructor Documentation

ns3::CtrlBAckRequestHeader::CtrlBAckRequestHeader ( )

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

ns3::CtrlBAckRequestHeader::~CtrlBAckRequestHeader ( )

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

Member Function Documentation

uint32_t ns3::CtrlBAckRequestHeader::Deserialize ( Buffer::Iterator  start)
virtual
Parameters
startan iterator which points to where the header should written.
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.

Implements ns3::Header.

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

References ns3::Buffer::Iterator::GetDistanceFrom(), m_compressed, m_multiTid, NS_FATAL_ERROR, ns3::Buffer::Iterator::ReadLsbtohU16(), SetBarControl(), SetStartingSequenceControl(), and visualizer.core::start().

+ Here is the call graph for this function:

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

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

References m_barAckPolicy, m_compressed, m_multiTid, and m_tidInfo.

Referenced by Serialize().

+ Here is the caller graph for this function:

TypeId ns3::CtrlBAckRequestHeader::GetInstanceTypeId ( void  ) const
virtual
Returns
the TypeId associated to the most-derived type of this instance.

This method is typically implemented by ns3::Object::GetInstanceTypeId but some classes which derive from ns3::ObjectBase directly have to implement it themselves.

Implements ns3::ObjectBase.

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

References GetTypeId().

+ Here is the call graph for this function:

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 m_compressed, m_multiTid, m_tidInfo, and NS_FATAL_ERROR.

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

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

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

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

References m_startingSeq.

Referenced by Serialize().

+ Here is the caller graph for this function:

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

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

References m_tidInfo.

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

+ Here is the caller graph for this function:

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

This method returns the TypeId associated to ns3::CtrlBAckRequestHeader.

No Attributes defined for this type.
No TraceSources defined for this type.

Reimplemented from ns3::Header.

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

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

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

References m_compressed, and m_multiTid.

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

+ Here is the caller graph for this function:

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

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

References m_compressed, and m_multiTid.

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

+ Here is the caller graph for this function:

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

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

References m_compressed, and m_multiTid.

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

+ Here is the caller graph for this function:

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

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

References m_barAckPolicy.

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 trailer as ascii data to a c++ output stream. Although the trailer 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.

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

References GetBarControl(), GetStartingSequenceControl(), m_compressed, m_multiTid, NS_FATAL_ERROR, visualizer.core::start(), and ns3::Buffer::Iterator::WriteHtolsbU16().

+ Here is the call graph for this function:

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

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

References m_barAckPolicy, m_compressed, m_multiTid, and m_tidInfo.

Referenced by Deserialize().

+ Here is the caller graph for this function:

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

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

References m_barAckPolicy.

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

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

References m_startingSeq.

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

+ Here is the caller graph for this function:

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

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

References m_startingSeq.

Referenced by Deserialize().

+ Here is the caller graph for this function:

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

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

References m_tidInfo.

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

+ Here is the caller graph for this function:

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

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

References ns3::BASIC_BLOCK_ACK, ns3::COMPRESSED_BLOCK_ACK, m_compressed, m_multiTid, ns3::MULTI_TID_BLOCK_ACK, and NS_FATAL_ERROR.

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

+ Here is the caller graph for this function:

Member Data Documentation

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.

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

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

bool ns3::CtrlBAckRequestHeader::m_compressed
private
bool ns3::CtrlBAckRequestHeader::m_multiTid
private
uint16_t ns3::CtrlBAckRequestHeader::m_startingSeq
private
uint16_t ns3::CtrlBAckRequestHeader::m_tidInfo
private

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