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

WifiAckPolicySelector is in charge of selecting the acknowledgment policy for PSDUs containing QoS Data frames. More...

#include "wifi-ack-policy-selector.h"

+ Inheritance diagram for ns3::WifiAckPolicySelector:
+ Collaboration diagram for ns3::WifiAckPolicySelector:

Public Member Functions

virtual ~WifiAckPolicySelector ()
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
Ptr< QosTxopGetQosTxop (void) const
 Get the QoS Txop associated with this ack policy selector. More...
 
void SetQosTxop (Ptr< QosTxop > qosTxop)
 Set the QoS Txop associated with this ack policy selector. More...
 
virtual void UpdateTxParams (Ptr< WifiPsdu > psdu, MacLowTransmissionParameters &params)=0
 Update the transmission parameters related to the acknowledgment policy for the given PSDU. 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...
 
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 SetAckPolicy (Ptr< WifiPsdu > psdu, const MacLowTransmissionParameters &params)
 Set the QoS Ack Policy for the QoS Data frames contained in the given PSDU according to the given MacLow transmission parameters. 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 Attributes

Ptr< QosTxopm_qosTxop
 the QoS Txop this selector is associated with More...
 

Additional Inherited Members

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

Detailed Description

WifiAckPolicySelector is in charge of selecting the acknowledgment policy for PSDUs containing QoS Data frames.


Introspection did not find any typical Config paths.


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 37 of file wifi-ack-policy-selector.h.

Constructor & Destructor Documentation

◆ ~WifiAckPolicySelector()

ns3::WifiAckPolicySelector::~WifiAckPolicySelector ( )
virtual

Definition at line 41 of file wifi-ack-policy-selector.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::WifiAckPolicySelector::DoDispose ( void  )
virtual

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 47 of file wifi-ack-policy-selector.cc.

References m_qosTxop, and NS_LOG_FUNCTION.

◆ GetQosTxop()

Ptr< QosTxop > ns3::WifiAckPolicySelector::GetQosTxop ( void  ) const

Get the QoS Txop associated with this ack policy selector.

Returns
the QoS Txop.

Definition at line 61 of file wifi-ack-policy-selector.cc.

References m_qosTxop.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 32 of file wifi-ack-policy-selector.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetAckPolicy()

void ns3::WifiAckPolicySelector::SetAckPolicy ( Ptr< WifiPsdu psdu,
const MacLowTransmissionParameters params 
)
static

Set the QoS Ack Policy for the QoS Data frames contained in the given PSDU according to the given MacLow transmission parameters.

Only single-TID A-MPDUs are supported at the moment, hence it is expected that all the QoS Data frames contained in the given PSDU have the same TID. This function is typically called by MacLow before forwarding the PSDU down to the PHY layer.

Parameters
psduthe given PSDU.
paramsthe given MacLow transmission parameters.

Definition at line 67 of file wifi-ack-policy-selector.cc.

References ns3::WifiMacHeader::BLOCK_ACK, ns3::MacLowTransmissionParameters::MustWaitBlockAck(), ns3::MacLowTransmissionParameters::MustWaitNormalAck(), ns3::WifiMacHeader::NORMAL_ACK, NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetQosTxop()

void ns3::WifiAckPolicySelector::SetQosTxop ( Ptr< QosTxop qosTxop)

Set the QoS Txop associated with this ack policy selector.

Parameters
qosTxopthe QoS Txop.

Definition at line 54 of file wifi-ack-policy-selector.cc.

References m_qosTxop, and NS_LOG_FUNCTION.

◆ UpdateTxParams()

virtual void ns3::WifiAckPolicySelector::UpdateTxParams ( Ptr< WifiPsdu psdu,
MacLowTransmissionParameters params 
)
pure virtual

Update the transmission parameters related to the acknowledgment policy for the given PSDU.

This method is typically called by the MPDU aggregator when trying to aggregate another MPDU to the current A-MPDU. In fact, the AckPolicySelector may switch to a different acknowledgment policy when a new MPDU is aggregated to an A-MPDU.

Parameters
psduthe given PSDU.
paramsthe MacLow parameters to update.

Implemented in ns3::ConstantWifiAckPolicySelector.

Member Data Documentation

◆ m_qosTxop

Ptr<QosTxop> ns3::WifiAckPolicySelector::m_qosTxop
protected

the QoS Txop this selector is associated with

Definition at line 88 of file wifi-ack-policy-selector.h.

Referenced by DoDispose(), GetQosTxop(), SetQosTxop(), and ns3::ConstantWifiAckPolicySelector::UpdateTxParams().


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