WifiDefaultAckManager is the default ack manager. More...

#include "wifi-default-ack-manager.h"

Inheritance diagram for ns3::WifiDefaultAckManager:

Collaboration diagram for ns3::WifiDefaultAckManager:

Public Member Functions
	WifiDefaultAckManager ()

virtual	~WifiDefaultAckManager ()

uint16_t	GetMaxDistFromStartingSeq (Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams) const
	Get the maximum distance between the starting sequence number of the Block Ack agreement which the given MPDU belongs to and each of the sequence numbers of the given MPDU and of all the QoS data frames included in the given TX parameters. More...

virtual std::unique_ptr< WifiAcknowledgment >	TryAddMpdu (Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams) override
	Determine the acknowledgment method to use if the given MPDU is added to the current frame. More...

virtual std::unique_ptr< WifiAcknowledgment >	TryAggregateMsdu (Ptr< const WifiMacQueueItem > msdu, const WifiTxParameters &txParams) override
	Determine the acknowledgment method to use if the given MSDU is aggregated to the current frame. More...

Public Member Functions inherited from ns3::WifiAckManager
virtual	~WifiAckManager ()

void	SetWifiMac (Ptr< WifiMac > mac)
	Set the MAC which is using this Acknowledgment Manager. 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<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= ([[maybe_unused]] 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 Public Member Functions inherited from ns3::WifiAckManager
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
bool	IsResponseNeeded (Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams) const
	Determine whether the (A-)MPDU containing the given MPDU and the MPDUs (if any) included in the given TX parameters requires an immediate response (Normal Ack, Block Ack or Block Ack Request followed by Block Ack). More...

Protected Member Functions inherited from ns3::WifiAckManager
void	DoDispose (void) override
	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...

Private Member Functions
virtual std::unique_ptr< WifiAcknowledgment >	GetAckInfoIfAggregatedMuBar (Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams)
	Compute the information about the acknowledgment of the current multi-user frame (as described by the given TX parameters) if the given MPDU is added. More...

virtual std::unique_ptr< WifiAcknowledgment >	GetAckInfoIfBarBaSequence (Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams)
	Compute the information about the acknowledgment of the current multi-user frame (as described by the given TX parameters) if the given MPDU is added. More...

virtual std::unique_ptr< WifiAcknowledgment >	GetAckInfoIfTfMuBar (Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams)
	Compute the information about the acknowledgment of the current multi-user frame (as described by the given TX parameters) if the given MPDU is added. More...

virtual std::unique_ptr< WifiAcknowledgment >	TryUlMuTransmission (Ptr< const WifiMacQueueItem > mpdu, const WifiTxParameters &txParams)
	Calculate the acknowledgment method for the TB PPDUs solicited by the given Trigger Frame. More...

Private Attributes
double	m_baThreshold
	Threshold to determine when a BlockAck must be requested. More...

WifiAcknowledgment::Method	m_dlMuAckType
	Type of the ack sequence for DL MU PPDUs. More...

uint8_t	m_maxMcsForBlockAckInTbPpdu
	Max MCS used to send a BlockAck in a TB PPDU. More...

bool	m_useExplicitBar
	true for sending BARs, false for using Implicit BAR policy More...

Additional Inherited Members
Protected Attributes inherited from ns3::WifiAckManager
Ptr< WifiMac >	m_mac
	MAC which is using this Acknowledgment Manager. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

WifiDefaultAckManager is the default ack manager.

Introspection did not find any typical Config paths.

Attributes

UseExplicitBar: Specify whether to send Block Ack Requests (if true) or use Implicit Block Ack Request ack policy (if false).
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
BaThreshold: Immediate acknowledgment is requested upon transmission of a frame whose sequence number is distant at least BaThreshold multiplied by the transmit window size from the starting sequence number of the transmit window. Set to zero to request a response for every transmitted frame.
- Set with class: ns3::DoubleValue
- Underlying type: double 0:1
- Initial value: 0
- Flags: construct write read
DlMuAckSequenceType: Type of the acknowledgment sequence for DL MU PPDUs.
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: DL_MU_BAR_BA_SEQUENCE
- Flags: construct write read
MaxBlockAckMcs: The MCS used to send a BlockAck in a TB PPDU is the minimum between the MCS used for the PSDU sent in the preceding DL MU PPDU and the value of this attribute.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:11
- Initial value: 5
- Flags: construct write read

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

Definition at line 37 of file wifi-default-ack-manager.h.

Constructor & Destructor Documentation

◆ WifiDefaultAckManager()

ns3::WifiDefaultAckManager::WifiDefaultAckManager ( )

Definition at line 80 of file wifi-default-ack-manager.cc.

References NS_LOG_FUNCTION.

◆ ~WifiDefaultAckManager()

ns3::WifiDefaultAckManager::~WifiDefaultAckManager ( )

virtual

Definition at line 85 of file wifi-default-ack-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ GetAckInfoIfAggregatedMuBar()

std::unique_ptr< WifiAcknowledgment > ns3::WifiDefaultAckManager::GetAckInfoIfAggregatedMuBar	(	Ptr< const WifiMacQueueItem >	mpdu,
		const WifiTxParameters &	txParams
	)

privatevirtual

Compute the information about the acknowledgment of the current multi-user frame (as described by the given TX parameters) if the given MPDU is added.

If the computed information is the same as the current one, a null pointer is returned. Otherwise, the computed information is returned. This method can only be called if the selected acknowledgment method for DL multi-user frames consists of MU-BAR Trigger Frames aggregated to the PSDUs of the MU PPDU.

Parameters

mpdu	the given MPDU
txParams	the TX parameters describing the current multi-user frame

Returns: the new acknowledgment method or a null pointer if the acknowledgment method is unchanged

Definition at line 555 of file wifi-default-ack-manager.cc.

Referenced by TryAddMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAckInfoIfBarBaSequence()

std::unique_ptr< WifiAcknowledgment > ns3::WifiDefaultAckManager::GetAckInfoIfBarBaSequence	(	Ptr< const WifiMacQueueItem >	mpdu,
		const WifiTxParameters &	txParams
	)

privatevirtual

Compute the information about the acknowledgment of the current multi-user frame (as described by the given TX parameters) if the given MPDU is added.

If the computed information is the same as the current one, a null pointer is returned. Otherwise, the computed information is returned. This method can only be called if the selected acknowledgment method for DL multi-user frames consists of a sequence of BlockAckReq and BlockAck frames.

Parameters

mpdu	the given MPDU
txParams	the TX parameters describing the current multi-user frame

Returns: the new acknowledgment method or a null pointer if the acknowledgment method is unchanged

Definition at line 342 of file wifi-default-ack-manager.cc.

References ns3::WifiMacHeader::BLOCK_ACK, ns3::WifiAcknowledgment::DL_MU_BAR_BA_SEQUENCE, ns3::WifiMacHeader::GetAddr1(), ns3::QosTxop::GetBaManager(), ns3::QosTxop::GetBlockAckReqType(), ns3::QosTxop::GetBlockAckType(), ns3::WifiTxParameters::GetPsduInfo(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiTxVector::IsDlMu(), ns3::WifiMacHeader::IsQosData(), ns3::WifiTxParameters::m_acknowledgment, m_dlMuAckType, ns3::WifiAckManager::m_mac, ns3::WifiTxParameters::m_txVector, ns3::WifiMacHeader::NORMAL_ACK, NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::QosUtilsMapTidToAc(), ns3::WifiAcknowledgment::SetQosAckPolicy(), ns3::WifiDlMuBarBaSequence::stationsReplyingWithBlockAck, ns3::WifiDlMuBarBaSequence::stationsReplyingWithNormalAck, and ns3::WifiDlMuBarBaSequence::stationsSendBlockAckReqTo.

Referenced by TryAddMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAckInfoIfTfMuBar()

std::unique_ptr< WifiAcknowledgment > ns3::WifiDefaultAckManager::GetAckInfoIfTfMuBar	(	Ptr< const WifiMacQueueItem >	mpdu,
		const WifiTxParameters &	txParams
	)

privatevirtual

Compute the information about the acknowledgment of the current multi-user frame (as described by the given TX parameters) if the given MPDU is added.

If the computed information is the same as the current one, a null pointer is returned. Otherwise, the computed information is returned. This method can only be called if the selected acknowledgment method for DL multi-user frames consists of a MU-BAR Trigger Frame sent as single-user frame.

Parameters

mpdu	the given MPDU
txParams	the TX parameters describing the current multi-user frame

Returns: the new acknowledgment method or a null pointer if the acknowledgment method is unchanged

Definition at line 471 of file wifi-default-ack-manager.cc.

Referenced by TryAddMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMaxDistFromStartingSeq()

uint16_t ns3::WifiDefaultAckManager::GetMaxDistFromStartingSeq	(	Ptr< const WifiMacQueueItem >	mpdu,
		const WifiTxParameters &	txParams
	)		const

Get the maximum distance between the starting sequence number of the Block Ack agreement which the given MPDU belongs to and each of the sequence numbers of the given MPDU and of all the QoS data frames included in the given TX parameters.

Parameters

mpdu	the given MPDU
txParams	the given TX parameters

Returns: the maximum distance between the starting sequence number of the Block Ack agreement which the given MPDU belongs to and each of the sequence numbers of the given MPDU and of all the QoS data frames included in the given TX parameters

Definition at line 91 of file wifi-default-ack-manager.cc.

References ns3::WifiMacHeader::GetAddr1(), ns3::QosTxop::GetBaAgreementEstablished(), ns3::QosTxop::GetBaStartingSequence(), ns3::WifiTxParameters::GetPsduInfo(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiAckManager::m_mac, NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::QosUtilsIsOldPacket(), ns3::SEQNO_SPACE_HALF_SIZE, ns3::SEQNO_SPACE_SIZE, and ns3::WifiTxParameters::PsduInfo::seqNumbers.

Referenced by IsResponseNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::WifiDefaultAckManager::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 41 of file wifi-default-ack-manager.cc.

References ns3::WifiAcknowledgment::DL_MU_AGGREGATE_TF, ns3::WifiAcknowledgment::DL_MU_BAR_BA_SEQUENCE, ns3::WifiAcknowledgment::DL_MU_TF_MU_BAR, m_baThreshold, m_dlMuAckType, m_maxMcsForBlockAckInTbPpdu, m_useExplicitBar, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleAccessor(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeUintegerAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IsResponseNeeded()

bool ns3::WifiDefaultAckManager::IsResponseNeeded	(	Ptr< const WifiMacQueueItem >	mpdu,
		const WifiTxParameters &	txParams
	)		const

protected

Determine whether the (A-)MPDU containing the given MPDU and the MPDUs (if any) included in the given TX parameters requires an immediate response (Normal Ack, Block Ack or Block Ack Request followed by Block Ack).

Parameters

mpdu	the given MPDU.
txParams	the given TX parameters.

Returns: true if the given PSDU requires an immediate response

Definition at line 135 of file wifi-default-ack-manager.cc.

References ns3::QosTxop::GetBaBufferSize(), ns3::QosTxop::GetBaManager(), GetMaxDistFromStartingSeq(), ns3::QosTxop::GetRemainingTxop(), ns3::Txop::GetTxopLimit(), ns3::Txop::GetWifiMacQueue(), ns3::Time::IsStrictlyPositive(), m_baThreshold, ns3::WifiAckManager::m_mac, ns3::WifiTxParameters::m_protection, NS_LOG_FUNCTION, and ns3::WifiProtection::RTS_CTS.

Referenced by TryAddMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TryAddMpdu()

std::unique_ptr< WifiAcknowledgment > ns3::WifiDefaultAckManager::TryAddMpdu	(	Ptr< const WifiMacQueueItem >	mpdu,
		const WifiTxParameters &	txParams
	)

overridevirtual

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

mpdu	the MPDU to be added to the current frame
txParams	the current TX parameters for the current frame

Returns: a null pointer if the acknowledgment method is unchanged or the new acknowledgment method otherwise

Implements ns3::WifiAckManager.

Definition at line 167 of file wifi-default-ack-manager.cc.

Here is the call graph for this function:

◆ TryAggregateMsdu()

std::unique_ptr< WifiAcknowledgment > ns3::WifiDefaultAckManager::TryAggregateMsdu	(	Ptr< const WifiMacQueueItem >	msdu,
		const WifiTxParameters &	txParams
	)

overridevirtual

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

msdu	the MSDU to be aggregated to the current frame
txParams	the current TX parameters for the current frame

Returns: a null pointer if the acknowledgment method is unchanged or the new acknowledgment method otherwise

Implements ns3::WifiAckManager.

Definition at line 332 of file wifi-default-ack-manager.cc.

References NS_LOG_FUNCTION.

◆ TryUlMuTransmission()

std::unique_ptr< WifiAcknowledgment > ns3::WifiDefaultAckManager::TryUlMuTransmission	(	Ptr< const WifiMacQueueItem >	mpdu,
		const WifiTxParameters &	txParams
	)