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
 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...
 
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 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...
 
virtual void Print (std::ostream &os) const
 
virtual 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 (enum BlockAckType type)
 Set the block ACK type. More...
 
- Public Member Functions inherited from ns3::Header
virtual ~Header ()
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
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)
 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...
 
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)
 This method is invoked once all member attributes have been initialized. More...
 

Detailed Description

Headers for Block ack request.

Doxygen 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.

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

Constructor & Destructor Documentation

ns3::CtrlBAckRequestHeader::CtrlBAckRequestHeader ( )

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

References NS_LOG_FUNCTION.

ns3::CtrlBAckRequestHeader::~CtrlBAckRequestHeader ( )

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

References NS_LOG_FUNCTION.

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

References ns3::Buffer::Iterator::GetDistanceFrom(), m_compressed, m_multiTid, NS_FATAL_ERROR, NS_LOG_FUNCTION, 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

Return the Block ACK control.

Returns
the Block ACK control

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

References m_barAckPolicy, m_compressed, m_multiTid, m_tidInfo, and NS_LOG_FUNCTION.

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

References GetTypeId(), and NS_LOG_FUNCTION.

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

References m_compressed, m_multiTid, m_tidInfo, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

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

Return the starting sequence number.

Returns
the starting sequence number

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

References m_startingSeq, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

Return the starting sequence control.

Returns
the starting sequence control

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

References m_startingSeq, and NS_LOG_FUNCTION.

Referenced by Serialize().

+ Here is the caller graph for this function:

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

Return the Traffic ID (TID).

Returns
TID

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

References m_tidInfo, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

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

References NS_LOG_FUNCTION_NOARGS, and 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

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

References m_compressed, m_multiTid, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

References m_compressed, m_multiTid, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

References m_compressed, m_multiTid, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

References m_barAckPolicy, and NS_LOG_FUNCTION.

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

References m_startingSeq, m_tidInfo, and NS_LOG_FUNCTION.

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

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

+ Here is the call graph for this function:

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

Set the Block ACK control.

Parameters
bar

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

References m_barAckPolicy, m_compressed, m_multiTid, m_tidInfo, and NS_LOG_FUNCTION.

Referenced by Deserialize().

+ Here is the caller graph for this function:

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, and NS_LOG_FUNCTION.

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

References m_startingSeq, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

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

Parameters
seqControl

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

References m_startingSeq, and NS_LOG_FUNCTION.

Referenced by Deserialize().

+ Here is the caller graph for this function:

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

Set Traffic ID (TID).

Parameters
tid

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

References m_tidInfo, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

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

Set the block ACK type.

Parameters
type

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

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

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 164 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: