A Discrete-Event Network Simulator
API
ns3::WifiAcknowledgment Struct Referenceabstract

WifiAcknowledgment is an abstract base struct. More...

#include "wifi-acknowledgment.h"

+ Inheritance diagram for ns3::WifiAcknowledgment:
+ Collaboration diagram for ns3::WifiAcknowledgment:

Public Types

enum  Method {
  NONE = 0, NORMAL_ACK, BLOCK_ACK, BAR_BLOCK_ACK,
  DL_MU_BAR_BA_SEQUENCE, DL_MU_TF_MU_BAR, DL_MU_AGGREGATE_TF
}
 Available acknowledgment methods. More...
 

Public Member Functions

 WifiAcknowledgment (Method m)
 Constructor. More...
 
virtual ~WifiAcknowledgment ()
 
WifiMacHeader::QosAckPolicy GetQosAckPolicy (Mac48Address receiver, uint8_t tid) const
 Get the QoS Ack policy to use for the MPDUs addressed to the given receiver and belonging to the given TID. More...
 
virtual void Print (std::ostream &os) const =0
 Print the object contents. More...
 
void SetQosAckPolicy (Mac48Address receiver, uint8_t tid, WifiMacHeader::QosAckPolicy ackPolicy)
 Set the QoS Ack policy to use for the MPDUs addressed to the given receiver and belonging to the given TID. More...
 

Public Attributes

Time acknowledgmentTime
 time required by the acknowledgment method More...
 
const Method method
 acknowledgment method More...
 

Private Member Functions

virtual bool CheckQosAckPolicy (Mac48Address receiver, uint8_t tid, WifiMacHeader::QosAckPolicy ackPolicy) const =0
 Check whether the given QoS Ack policy can be used for the MPDUs addressed to the given receiver and belonging to the given TID. More...
 

Private Attributes

std::map< std::pair< Mac48Address, uint8_t >, WifiMacHeader::QosAckPolicym_ackPolicy
 Qos Ack Policy to set for MPDUs addressed to a given receiver and having a given TID. More...
 

Detailed Description

WifiAcknowledgment is an abstract base struct.

Each derived struct defines an acknowledgment method and stores the information needed to perform acknowledgment according to that method.

Definition at line 43 of file wifi-acknowledgment.h.

Member Enumeration Documentation

◆ Method

Available acknowledgment methods.

Enumerator
NONE 
NORMAL_ACK 
BLOCK_ACK 
BAR_BLOCK_ACK 
DL_MU_BAR_BA_SEQUENCE 
DL_MU_TF_MU_BAR 
DL_MU_AGGREGATE_TF 

Definition at line 49 of file wifi-acknowledgment.h.

Constructor & Destructor Documentation

◆ WifiAcknowledgment()

ns3::WifiAcknowledgment::WifiAcknowledgment ( Method  m)

Constructor.

Parameters
mthe acknowledgment method for this object

Definition at line 31 of file wifi-acknowledgment.cc.

◆ ~WifiAcknowledgment()

ns3::WifiAcknowledgment::~WifiAcknowledgment ( )
virtual

Definition at line 37 of file wifi-acknowledgment.cc.

Member Function Documentation

◆ CheckQosAckPolicy()

virtual bool ns3::WifiAcknowledgment::CheckQosAckPolicy ( Mac48Address  receiver,
uint8_t  tid,
WifiMacHeader::QosAckPolicy  ackPolicy 
) const
privatepure virtual

Check whether the given QoS Ack policy can be used for the MPDUs addressed to the given receiver and belonging to the given TID.

Parameters
receiverthe MAC address of the receiver
tidthe TID
ackPolicythe QoS Ack policy to use
Returns
true if the given QoS Ack policy can be used, false otherwise

Implemented in ns3::WifiDlMuAggregateTf, ns3::WifiDlMuTfMuBar, ns3::WifiDlMuBarBaSequence, ns3::WifiBarBlockAck, ns3::WifiBlockAck, ns3::WifiNormalAck, and ns3::WifiNoAck.

Referenced by SetQosAckPolicy().

+ Here is the caller graph for this function:

◆ GetQosAckPolicy()

WifiMacHeader::QosAckPolicy ns3::WifiAcknowledgment::GetQosAckPolicy ( Mac48Address  receiver,
uint8_t  tid 
) const

Get the QoS Ack policy to use for the MPDUs addressed to the given receiver and belonging to the given TID.

Parameters
receiverthe MAC address of the receiver
tidthe TID
Returns
the QoS Ack policy to use

Definition at line 42 of file wifi-acknowledgment.cc.

References m_ackPolicy, and NS_ASSERT.

Referenced by ns3::WifiAckManager::SetQosAckPolicy().

+ Here is the caller graph for this function:

◆ Print()

virtual void ns3::WifiAcknowledgment::Print ( std::ostream &  os) const
pure virtual

Print the object contents.

Parameters
osoutput stream in which the data should be printed.

Implemented in ns3::WifiDlMuAggregateTf, ns3::WifiDlMuTfMuBar, ns3::WifiDlMuBarBaSequence, ns3::WifiBarBlockAck, ns3::WifiBlockAck, ns3::WifiNormalAck, and ns3::WifiNoAck.

Referenced by ns3::operator<<().

+ Here is the caller graph for this function:

◆ SetQosAckPolicy()

void ns3::WifiAcknowledgment::SetQosAckPolicy ( Mac48Address  receiver,
uint8_t  tid,
WifiMacHeader::QosAckPolicy  ackPolicy 
)

Set the QoS Ack policy to use for the MPDUs addressed to the given receiver and belonging to the given TID.

If the pair (receiver, TID) already exists, it is overwritten with the given QoS Ack policy.

Parameters
receiverthe MAC address of the receiver
tidthe TID
ackPolicythe QoS Ack policy to use

Definition at line 50 of file wifi-acknowledgment.cc.

References CheckQosAckPolicy(), m_ackPolicy, and NS_ABORT_MSG_IF.

Referenced by ns3::WifiDefaultAckManager::TryAddMpdu().

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

Member Data Documentation

◆ acknowledgmentTime

◆ m_ackPolicy

std::map<std::pair<Mac48Address, uint8_t>, WifiMacHeader::QosAckPolicy> ns3::WifiAcknowledgment::m_ackPolicy
private

Qos Ack Policy to set for MPDUs addressed to a given receiver and having a given TID.

Definition at line 111 of file wifi-acknowledgment.h.

Referenced by GetQosAckPolicy(), and SetQosAckPolicy().

◆ method

const Method ns3::WifiAcknowledgment::method

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