A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::CtrlBAckResponseHeader Class Reference
Wifi Models

Headers for Block ack response. More...

#include <ctrl-headers.h>

+ Inheritance diagram for ns3::CtrlBAckResponseHeader:

Public Member Functions

virtual uint32_t Deserialize (Buffer::Iterator start)
 
const uint16_t * GetBitmap (void) const
 
uint64_t GetCompressedBitmap (void) const
 
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 IsFragmentReceived (uint16_t seq, uint8_t frag) const
 
bool IsMultiTid (void) const
 
bool IsPacketReceived (uint16_t seq) const
 
bool MustSendHtImmediateAck (void) const
 
virtual void Print (std::ostream &os) const
 
void ResetBitmap (void)
 
virtual void Serialize (Buffer::Iterator start) const
 
void SetHtImmediateAck (bool immeadiateAck)
 
void SetReceivedFragment (uint16_t seq, uint8_t frag)
 
void SetReceivedPacket (uint16_t seq)
 
void SetStartingSequence (uint16_t seq)
 
void SetStartingSequenceControl (uint16_t seqControl)
 
void SetTidInfo (uint8_t tid)
 
void SetType (enum BlockAckType type)
 
- Public Member Functions inherited from ns3::ObjectBase
void GetAttribute (std::string name, AttributeValue &value) const
 
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
 
void SetAttribute (std::string name, const AttributeValue &value)
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Header
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Chunk
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

Buffer::Iterator DeserializeBitmap (Buffer::Iterator start)
 
uint16_t GetBaControl (void) const
 
uint8_t IndexInBitmap (uint16_t seq) const
 
bool IsInBitmap (uint16_t seq) const
 
Buffer::Iterator SerializeBitmap (Buffer::Iterator start) const
 
void SetBaControl (uint16_t bar)
 

Private Attributes

union {
   uint16_t   m_bitmap [64]
 
   uint64_t   m_compressedBitmap
 
} bitmap
 
bool m_baAckPolicy
 
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 response.

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.

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Member Function Documentation

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

References ns3::Buffer::Iterator::GetDistanceFrom(), NS_FATAL_ERROR, NS_LOG_FUNCTION, and ns3::Buffer::Iterator::ReadLsbtohU16().

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

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

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

uint8_t ns3::CtrlBAckResponseHeader::IndexInBitmap ( uint16_t  seq) 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
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 741 of file ctrl-headers.cc.

References NS_ASSERT, and NS_LOG_FUNCTION.

bool ns3::CtrlBAckResponseHeader::IsInBitmap ( uint16_t  seq) const
private

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

Parameters
seqthe sequence number
Returns

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

References NS_LOG_FUNCTION.

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

References NS_LOG_FUNCTION.

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 NS_FATAL_ERROR, NS_LOG_FUNCTION, and ns3::Buffer::Iterator::WriteHtolsbU16().

Member Data Documentation

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.

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

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