A Discrete-Event Network Simulator
API
ns3::WifiAckManager Class Referenceabstract

WifiAckManager is an abstract base class. More...

#include "wifi-ack-manager.h"

+ Inheritance diagram for ns3::WifiAckManager:
+ Collaboration diagram for ns3::WifiAckManager:

Public Member Functions

virtual ~WifiAckManager ()
 
void SetWifiMac (Ptr< RegularWifiMac > mac)
 Set the MAC which is using this Acknowledgment Manager. More...
 
virtual std::unique_ptr< WifiAcknowledgmentTryAddMpdu (Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams)=0
 Determine the acknowledgment method to use if the given MPDU is added to the current frame. More...
 
virtual std::unique_ptr< WifiAcknowledgmentTryAggregateMsdu (Ptr< const WifiMacQueueItem > msdu, const WifiTxParameters &txParams)=0
 Determine the acknowledgment method to use if the given MSDU is aggregated to the current frame. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. 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 void SetQosAckPolicy (Ptr< WifiMacQueueItem > item, const WifiAcknowledgment *acknowledgment)
 Set the QoS Ack policy for the given MPDU, which must be a QoS data frame. More...
 
static void SetQosAckPolicy (Ptr< WifiPsdu > psdu, const WifiAcknowledgment *acknowledgment)
 Set the QoS Ack policy for the given PSDU, which must include at least a QoS data frame. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- 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...
 

Protected Attributes

Ptr< RegularWifiMacm_mac
 MAC which is using this Acknowledgment Manager. More...
 

Additional Inherited Members

Detailed Description

WifiAckManager is an abstract base class.


Introspection did not find any typical Config paths.

Each subclass defines a logic to select the acknowledgment method for a given frame.


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

Definition at line 42 of file wifi-ack-manager.h.

Constructor & Destructor Documentation

◆ ~WifiAckManager()

ns3::WifiAckManager::~WifiAckManager ( )
virtual

Definition at line 43 of file wifi-ack-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoDispose()

void ns3::WifiAckManager::DoDispose ( void  )
protectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 49 of file wifi-ack-manager.cc.

References ns3::Object::DoDispose(), m_mac, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 34 of file wifi-ack-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetQosAckPolicy() [1/2]

void ns3::WifiAckManager::SetQosAckPolicy ( Ptr< WifiMacQueueItem item,
const WifiAcknowledgment acknowledgment 
)
static

Set the QoS Ack policy for the given MPDU, which must be a QoS data frame.

Parameters
itemthe MPDU
acknowledgmentthe WifiAcknowledgment object storing the QoS Ack policy to set

Definition at line 64 of file wifi-ack-manager.cc.

References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacQueueItem::GetHeader(), ns3::WifiAcknowledgment::GetQosAckPolicy(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiMacHeader::IsQosData(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::WifiMacHeader::SetQosAckPolicy().

Referenced by ns3::FrameExchangeManager::SendMpduWithProtection(), ns3::HtFrameExchangeManager::SendPsduWithProtection(), and SetQosAckPolicy().

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

◆ SetQosAckPolicy() [2/2]

void ns3::WifiAckManager::SetQosAckPolicy ( Ptr< WifiPsdu psdu,
const WifiAcknowledgment acknowledgment 
)
static

Set the QoS Ack policy for the given PSDU, which must include at least a QoS data frame.

Parameters
psduthe PSDU
acknowledgmentthe WifiAcknowledgment object storing the QoS Ack policy to set

Definition at line 79 of file wifi-ack-manager.cc.

References ns3::WifiPsdu::begin(), ns3::WifiPsdu::GetAddr1(), ns3::WifiPsdu::GetNMpdus(), ns3::WifiAcknowledgment::GetQosAckPolicy(), ns3::WifiPsdu::GetTids(), NS_ASSERT, NS_LOG_FUNCTION, ns3::WifiPsdu::SetAckPolicyForTid(), and SetQosAckPolicy().

+ Here is the call graph for this function:

◆ SetWifiMac()

void ns3::WifiAckManager::SetWifiMac ( Ptr< RegularWifiMac mac)

Set the MAC which is using this Acknowledgment Manager.

Parameters
maca pointer to the MAC

Definition at line 57 of file wifi-ack-manager.cc.

References m_mac, third::mac, and NS_LOG_FUNCTION.

Referenced by PowerRateAdaptationTest::ConfigureNode(), WifiTest::CreateOne(), InterferenceHelperSequenceTest::CreateOne(), AmpduAggregationTest::DoRun(), TwoLevelAggregationTest::DoRun(), DcfImmediateAccessBroadcastTestCase::DoRun(), Bug2831TestCase::DoRun(), and HeAggregationTest::DoRunSubTest().

+ Here is the caller graph for this function:

◆ TryAddMpdu()

virtual std::unique_ptr<WifiAcknowledgment> ns3::WifiAckManager::TryAddMpdu ( Ptr< const WifiMacQueueItem mpdu,
const WifiTxParameters txParams 
)
pure virtual

Determine the acknowledgment method to use if the given MPDU is added to the current frame.

Return a null pointer if the acknowledgment method is unchanged or the new acknowledgment method otherwise.

Parameters
mpduthe MPDU to be added to the current frame
txParamsthe current TX parameters for the current frame
Returns
a null pointer if the acknowledgment method is unchanged or the new acknowledgment method otherwise

Implemented in ns3::WifiDefaultAckManager.

◆ TryAggregateMsdu()

virtual std::unique_ptr<WifiAcknowledgment> ns3::WifiAckManager::TryAggregateMsdu ( Ptr< const WifiMacQueueItem msdu,
const WifiTxParameters txParams 
)
pure virtual

Determine the acknowledgment method to use if the given MSDU is aggregated to the current frame.

Return a null pointer if the acknowledgment method is unchanged or the new acknowledgment method otherwise.

Parameters
msduthe MSDU to be aggregated to the current frame
txParamsthe current TX parameters for the current frame
Returns
a null pointer if the acknowledgment method is unchanged or the new acknowledgment method otherwise

Implemented in ns3::WifiDefaultAckManager.

Member Data Documentation

◆ m_mac

Ptr<RegularWifiMac> ns3::WifiAckManager::m_mac
protected

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