EhtFrameExchangeManager handles the frame exchange sequences for EHT stations. More...

#include "eht-frame-exchange-manager.h"

Inheritance diagram for ns3::EhtFrameExchangeManager:

Collaboration diagram for ns3::EhtFrameExchangeManager:

Public Member Functions
	EhtFrameExchangeManager ()

	~EhtFrameExchangeManager () override

Ptr< WifiMpdu >	CreateAliasIfNeeded (Ptr< WifiMpdu > mpdu) const override
	Create an alias of the given MPDU for transmission by this Frame Exchange Manager.

bool	GetEmlsrSwitchToListening (Ptr< const WifiPsdu > psdu, uint16_t aid, const Mac48Address &address) const

std::optional< double >	GetMostRecentRssi (const Mac48Address &address) const override
	Get the RSSI (in dBm) of the most recent packet received from the station having the given address.

void	SendEmlOperatingModeNotification (const Mac48Address &dest, const MgtEmlOperatingModeNotification &frame)
	Send an EML Operating Mode Notification frame to the given station.

void	SetLinkId (uint8_t linkId) override
	Set the ID of the link this Frame Exchange Manager is associated with.

Public Member Functions inherited from ns3::HeFrameExchangeManager
	HeFrameExchangeManager ()

	~HeFrameExchangeManager () override

void	CalculateAcknowledgmentTime (WifiAcknowledgment *acknowledgment) const override
	Calculate the time required to acknowledge a frame according to the given acknowledgment method.

void	CalculateProtectionTime (WifiProtection *protection) const override
	Calculate the time required to protect a frame according to the given protection method.

virtual std::optional< double >	GetMostRecentRssi (const Mac48Address &address) const
	Get the RSSI (in dBm) of the most recent packet received from the station having the given address.

uint16_t	GetSupportedBaBufferSize () const override
	Get the maximum supported buffer size for a Block Ack agreement.

bool	IsIntraBssPpdu (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector) const
	Return whether the received frame is classified as intra-BSS.

void	SetMultiUserScheduler (const Ptr< MultiUserScheduler > muScheduler)
	Set the Multi-user Scheduler associated with this Frame Exchange Manager.

virtual void	SetTargetRssi (CtrlTriggerHeader &trigger) const
	Set the UL Target RSSI subfield of every User Info fields of the given Trigger Frame to the most recent RSSI observed from the corresponding station.

void	SetTxopHolder (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector) override
	Set the TXOP holder, if needed, based on the received frame.

void	SetWifiMac (const Ptr< WifiMac > mac) override
	Set the MAC layer to use.

void	SetWifiPhy (const Ptr< WifiPhy > phy) override
	Set the PHY layer to use.

bool	StartFrameExchange (Ptr< QosTxop > edca, Time availableTime, bool initialFrame) override
	Start a frame exchange (including protection frames and acknowledgment frames as needed) that fits within the given availableTime (if different than Time::Min()).

bool	UlMuCsMediumIdle (const CtrlTriggerHeader &trigger) const
	This method is intended to be called a SIFS after the reception of a Trigger Frame to determine whether the station is allowed to respond.

bool	VirtualCsMediumIdle () const override

Public Member Functions inherited from ns3::VhtFrameExchangeManager
	VhtFrameExchangeManager ()

	~VhtFrameExchangeManager () override

Public Member Functions inherited from ns3::HtFrameExchangeManager
	HtFrameExchangeManager ()

	~HtFrameExchangeManager () override

void	CalculateAcknowledgmentTime (WifiAcknowledgment *acknowledgment) const override
	Calculate the time required to acknowledge a frame according to the given acknowledgment method.

Ptr< WifiMpdu >	GetBar (AcIndex ac, std::optional< uint8_t > optTid=std::nullopt, std::optional< Mac48Address > optAddress=std::nullopt)
	Get the next BlockAckRequest or MU-BAR Trigger Frame to send, if any.

Ptr< MpduAggregator >	GetMpduAggregator () const
	Returns the aggregator used to construct A-MPDU subframes.

Ptr< MsduAggregator >	GetMsduAggregator () const
	Returns the aggregator used to construct A-MSDU subframes.

virtual uint16_t	GetSupportedBaBufferSize () const
	Get the maximum supported buffer size for a Block Ack agreement.

virtual bool	IsWithinAmpduSizeLimit (uint32_t ampduSize, Mac48Address receiver, uint8_t tid, WifiModulationClass modulation) const
	Check whether an A-MPDU of the given size meets the constraint on the maximum size for A-MPDUs sent to the given receiver, belonging to the given TID and transmitted using the given modulation class.

bool	IsWithinLimitsIfAddMpdu (Ptr< const WifiMpdu > mpdu, const WifiTxParameters &txParams, Time ppduDurationLimit) const override
	Check if the PSDU obtained by aggregating the given MPDU to the PSDU specified by the given TX parameters meets the constraints on the maximum A-MPDU size and its transmission time does not exceed the given PPDU duration limit (if different than Time::Min()).

virtual bool	IsWithinLimitsIfAggregateMsdu (Ptr< const WifiMpdu > msdu, const WifiTxParameters &txParams, Time ppduDurationLimit) const
	Check if the PSDU obtained by aggregating the given MSDU to the PSDU specified by the given TX parameters meets the constraints on the maximum A-MSDU size and its transmission time does not exceed the given PPDU duration limit (if different than Time::Min()).

void	SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr, Mac48Address originator)
	This method can be called to accept a received ADDBA Request.

void	SendDelbaFrame (Mac48Address addr, uint8_t tid, bool byOriginator)
	Sends DELBA frame to cancel a block ack agreement with STA addressed by addr for TID tid.

void	SetWifiMac (const Ptr< WifiMac > mac) override
	Set the MAC layer to use.

bool	StartFrameExchange (Ptr< QosTxop > edca, Time availableTime, bool initialFrame) override
	Start a frame exchange (including protection frames and acknowledgment frames as needed) that fits within the given availableTime (if different than Time::Min()).

virtual bool	TryAggregateMsdu (Ptr< const WifiMpdu > msdu, WifiTxParameters &txParams, Time availableTime) const
	Check if aggregating an MSDU to the current MPDU (as specified by the given TX parameters) does not violate the size and time constraints, while taking into account the possibly updated protection and acknowledgment methods.

Public Member Functions inherited from ns3::QosFrameExchangeManager
	QosFrameExchangeManager ()

	~QosFrameExchangeManager () override

virtual Ptr< WifiMpdu >	CreateAliasIfNeeded (Ptr< WifiMpdu > mpdu) const
	Create an alias of the given MPDU for transmission by this Frame Exchange Manager.

virtual bool	IsWithinLimitsIfAddMpdu (Ptr< const WifiMpdu > mpdu, const WifiTxParameters &txParams, Time ppduDurationLimit) const
	Check whether the given MPDU can be added to the frame being built (as described by the given TX parameters) without violating the given constraint on the PPDU transmission duration.

virtual bool	IsWithinSizeAndTimeLimits (uint32_t ppduPayloadSize, Mac48Address receiver, const WifiTxParameters &txParams, Time ppduDurationLimit) const
	Check whether the transmission time of the frame being built (as described by the given TX parameters) does not exceed the given PPDU duration limit if the size of the PSDU addressed to the given receiver becomes ppduPayloadSize.

bool	StartTransmission (Ptr< Txop > edca, uint16_t allowedWidth) override
	Request the FrameExchangeManager to start a frame exchange sequence.

bool	TryAddMpdu (Ptr< const WifiMpdu > mpdu, WifiTxParameters &txParams, Time availableTime) const
	Recompute the protection and acknowledgment methods to use if the given MPDU is added to the frame being built (as described by the given TX parameters) and check whether the duration of the frame exchange sequence (including protection and acknowledgment) does not exceed the given available time.

Public Member Functions inherited from ns3::FrameExchangeManager
	FrameExchangeManager ()

	~FrameExchangeManager () override

virtual void	CalculateAcknowledgmentTime (WifiAcknowledgment *acknowledgment) const
	Calculate the time required to acknowledge a frame according to the given acknowledgment method.

virtual void	CalculateProtectionTime (WifiProtection *protection) const
	Calculate the time required to protect a frame according to the given protection method.

Ptr< WifiAckManager >	GetAckManager () const
	Get the Acknowledgment Manager used by this node.

Mac48Address	GetAddress () const
	Get the MAC address.

Mac48Address	GetBssid () const
	Get the Basic Service Set Identification.

const std::set< Mac48Address > &	GetProtectedStas () const

Ptr< WifiProtectionManager >	GetProtectionManager () const
	Get the Protection Manager used by this node.

const WifiTxTimer &	GetWifiTxTimer () const
	Get a const reference to the WifiTxTimer object.

bool	IsPromisc () const
	Check if the device is operating in promiscuous mode.

virtual void	NotifyInternalCollision (Ptr< Txop > txop)
	Notify that an internal collision has occurred for the given Txop.

void	NotifyOffNow ()
	This method is typically invoked by the PhyListener to notify the MAC layer that the device has been put into off mode.

void	NotifySleepNow ()
	This method is typically invoked by the PhyListener to notify the MAC layer that the device has been put into sleep mode.

virtual void	NotifySwitchingStartNow (Time duration)

void	Receive (Ptr< const WifiPsdu > psdu, RxSignalInfo rxSignalInfo, WifiTxVector txVector, std::vector< bool > perMpduStatus)
	This method is intended to be called by the PHY layer every time an MPDU is received and also when the reception of an A-MPDU is completed.

virtual void	ResetPhy ()
	Remove WifiPhy associated with this FrameExchangeManager.

void	SetAckedMpduCallback (AckedMpdu callback)
	Set the callback to invoke when an MPDU is successfully acked.

virtual void	SetAckManager (Ptr< WifiAckManager > ackManager)
	Set the Acknowledgment Manager to use.

virtual void	SetAddress (Mac48Address address)
	Set the MAC address.

virtual void	SetBssid (Mac48Address bssid)
	Set the Basic Service Set Identification.

virtual void	SetChannelAccessManager (const Ptr< ChannelAccessManager > channelAccessManager)
	Set the channel access manager to use.

virtual void	SetDroppedMpduCallback (DroppedMpdu callback)
	Set the callback to invoke when an MPDU is dropped.

virtual void	SetLinkId (uint8_t linkId)
	Set the ID of the link this Frame Exchange Manager is associated with.

virtual void	SetMacRxMiddle (const Ptr< MacRxMiddle > rxMiddle)
	Set the MAC RX Middle to use.

virtual void	SetMacTxMiddle (const Ptr< MacTxMiddle > txMiddle)
	Set the MAC TX Middle to use.

void	SetPromisc ()
	Enable promiscuous mode.

virtual void	SetProtectionManager (Ptr< WifiProtectionManager > protectionManager)
	Set the Protection Manager to use.

virtual void	SetWifiMac (const Ptr< WifiMac > mac)
	Set the MAC layer to use.

virtual void	SetWifiPhy (const Ptr< WifiPhy > phy)
	Set the PHY layer to use.

virtual bool	StartTransmission (Ptr< Txop > dcf, uint16_t allowedWidth)
	Request the FrameExchangeManager to start a frame exchange sequence.

virtual bool	VirtualCsMediumIdle () const

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

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

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

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

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

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::HeFrameExchangeManager
static Ptr< WifiPsdu >	GetPsduTo (Mac48Address to, const WifiPsduMap &psduMap)
	Get the PSDU in the given PSDU map that is addressed to the given MAC address, if any, or a null pointer, otherwise.

static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::VhtFrameExchangeManager
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::HtFrameExchangeManager
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::QosFrameExchangeManager
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::FrameExchangeManager
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	EmlsrSwitchToListening (const Mac48Address &address, const Time &delay)
	This method is intended to be called when an AP MLD detects that an EMLSR client previously involved in the current TXOP will start waiting for the transition delay interval (to switch back to listening operation) after the given delay.

void	ForwardPsduDown (Ptr< const WifiPsdu > psdu, WifiTxVector &txVector) override
	Forward a PSDU down to the PHY layer.

void	ForwardPsduMapDown (WifiConstPsduMap psduMap, WifiTxVector &txVector) override
	Forward a map of PSDUs down to the PHY layer.

void	NotifyChannelReleased (Ptr< Txop > txop) override
	Notify the given Txop that channel has been released.

void	SendMuRts (const WifiTxParameters &txParams) override
	Send an MU-RTS to begin an MU-RTS/CTS frame exchange protecting an MU PPDU.

Protected Member Functions inherited from ns3::HeFrameExchangeManager
virtual void	BlockAckAfterTbPpduTimeout (Ptr< WifiPsdu > psdu, const WifiTxVector &txVector)
	Take the necessary actions after that a Block Ack is missing after a TB PPDU solicited through a Trigger Frame.

virtual void	BlockAcksInTbPpduTimeout (WifiPsduMap psduMap, const std::set< Mac48Address > staMissedBlockAckFrom, std::size_t nSolicitedStations)
	Take the necessary actions after that some BlockAck frames are missing in response to a DL MU PPDU.

void	BlockAckTimeout (Ptr< WifiPsdu > psdu, const WifiTxVector &txVector) override
	Called when the BlockAck timeout expires.

void	ClearTxopHolderIfNeeded () override
	Clear the TXOP holder if the intra-BSS NAV counted down to zero (includes the case of intra-BSS NAV reset).

virtual void	CtsAfterMuRtsTimeout (Ptr< WifiMpdu > muRts, const WifiTxVector &txVector)
	Called when no CTS frame is received after an MU-RTS.

void	CtsTimeout (Ptr< WifiMpdu > rts, const WifiTxVector &txVector) override
	Called when the CTS timeout expires.

void	DoDispose () override
	Destructor implementation.

void	EndReceiveAmpdu (Ptr< const WifiPsdu > psdu, const RxSignalInfo &rxSignalInfo, const WifiTxVector &txVector, const std::vector< bool > &perMpduStatus) override
	This method is called when the reception of an A-MPDU including multiple MPDUs is completed.

virtual void	ForwardPsduMapDown (WifiConstPsduMap psduMap, WifiTxVector &txVector)
	Forward a map of PSDUs down to the PHY layer.

WifiMode	GetCtsModeAfterMuRts () const

WifiTxVector	GetCtsTxVectorAfterMuRts (const CtrlTriggerHeader &trigger, uint16_t staId) const
	Get the TXVECTOR that the station having the given station ID has to use to send a CTS frame after receiving an MU-RTS Trigger Frame from the AP it is associated with.

WifiTxVector	GetHeTbTxVector (CtrlTriggerHeader trigger, Mac48Address triggerSender) const
	Return a TXVECTOR for the UL frame that the station will send in response to the given Trigger frame, configured with the BSS color and transmit power level to use for the consequent HE TB PPDU.

virtual Time	GetMuRtsDurationId (uint32_t muRtsSize, const WifiTxVector &muRtsTxVector, Time txDuration, Time response) const
	Compute how to set the Duration/ID field of an MU-RTS Trigger Frame to send to protect a frame transmitted with the given TX vector.

WifiTxVector	GetTrigVector (const CtrlTriggerHeader &trigger) const
	Get the TRIGVECTOR that the MAC has to pass to the PHY when transmitting the given Trigger Frame.

Time	GetTxDuration (uint32_t ppduPayloadSize, Mac48Address receiver, const WifiTxParameters &txParams) const override
	Get the updated TX duration of the frame associated with the given TX parameters if the size of the PSDU addressed to the given receiver becomes ppduPayloadSize.

virtual void	IntraBssNavResetTimeout ()
	Reset the intra-BSS NAV upon expiration of the intra-BSS NAV reset timer.

void	NavResetTimeout () override
	Reset the NAV upon expiration of the NAV reset timer.

void	NormalAckTimeout (Ptr< WifiMpdu > mpdu, const WifiTxVector &txVector) override
	Called when the Ack timeout expires.

void	PostProcessFrame (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector) override
	Perform actions that are possibly needed after receiving any frame, independently of whether the frame is addressed to this station (e.g., setting the NAV or the TXOP holder).

Ptr< WifiMpdu >	PrepareMuBar (const WifiTxVector &responseTxVector, std::map< uint16_t, CtrlBAckRequestHeader > recipients) const
	Build a MU-BAR Trigger Frame starting from the TXVECTOR used to respond to the MU-BAR (in case of multiple responders, their TXVECTORs need to be "merged" into a single TXVECTOR) and from the BlockAckReq headers for every recipient.

void	ProtectionCompleted () override
	Transmit prepared frame upon successful protection mechanism.

void	ReceiveMpdu (Ptr< const WifiMpdu > mpdu, RxSignalInfo rxSignalInfo, const WifiTxVector &txVector, bool inAmpdu) override
	This method handles the reception of an MPDU (possibly included in an A-MPDU)

void	RecordSentMuRtsTo (const WifiTxParameters &txParams)
	Record the stations being solicited by an MU-RTS TF.

void	Reset () override
	Reset this frame exchange manager.

void	SendCtsAfterMuRts (const WifiMacHeader &muRtsHdr, const CtrlTriggerHeader &trigger, double muRtsSnr)
	Send CTS after receiving an MU-RTS.

bool	SendMpduFromBaManager (Ptr< WifiMpdu > mpdu, Time availableTime, bool initialFrame) override
	If the given MPDU contains a BlockAckReq frame (the duration of which plus the response fits within the given available time, if the latter is not Time::Min() and this is not the initial frame of a TXOP), transmit the frame and return true.

void	SendMultiStaBlockAck (const WifiTxParameters &txParams, Time durationId)
	Send a Multi-STA Block Ack frame after the reception of some TB PPDUs.

virtual void	SendMuRts (const WifiTxParameters &txParams)
	Send an MU-RTS to begin an MU-RTS/CTS frame exchange protecting an MU PPDU.

void	SendPsduMapWithProtection (WifiPsduMap psduMap, WifiTxParameters &txParams)
	Send a map of PSDUs as a DL MU PPDU.

void	SendQosNullFramesInTbPpdu (const CtrlTriggerHeader &trigger, const WifiMacHeader &hdr)
	Send QoS Null frames in response to a Basic or BSRP Trigger Frame.

void	StartProtection (const WifiTxParameters &txParams) override
	Start the protection mechanism indicated by the given TX parameters.

virtual void	TbPpduTimeout (WifiPsduMap psduMap, const std::set< Mac48Address > staMissedTbPpduFrom, std::size_t nSolicitedStations)
	Take the necessary actions after that some TB PPDUs are missing in response to Trigger Frame.

void	UpdateNav (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector) override
	Update the NAV, if needed, based on the Duration/ID of the given psdu.

Protected Member Functions inherited from ns3::VhtFrameExchangeManager
uint32_t	GetPsduSize (Ptr< const WifiMpdu > mpdu, const WifiTxVector &txVector) const override
	Get the size in bytes of the given MPDU, which is to be transmitted with the given TXVECTOR.

Ptr< WifiPsdu >	GetWifiPsdu (Ptr< WifiMpdu > mpdu, const WifiTxVector &txVector) const override
	Get a PSDU containing the given MPDU.

Protected Member Functions inherited from ns3::HtFrameExchangeManager
virtual void	BlockAckTimeout (Ptr< WifiPsdu > psdu, const WifiTxVector &txVector)
	Called when the BlockAck timeout expires.

void	CtsTimeout (Ptr< WifiMpdu > rts, const WifiTxVector &txVector) override
	Called when the CTS timeout expires.

void	DequeuePsdu (Ptr< const WifiPsdu > psdu)
	Dequeue the MPDUs of the given PSDU from the queue in which they are stored.

void	DoDispose () override
	Destructor implementation.

void	EndReceiveAmpdu (Ptr< const WifiPsdu > psdu, const RxSignalInfo &rxSignalInfo, const WifiTxVector &txVector, const std::vector< bool > &perMpduStatus) override
	This method is called when the reception of an A-MPDU including multiple MPDUs is completed.

void	FinalizeMacHeader (Ptr< const WifiPsdu > psdu) override
	Finalize the MAC header of the MPDUs in the given PSDU before transmission.

void	ForwardMpduDown (Ptr< WifiMpdu > mpdu, WifiTxVector &txVector) override
	Forward an MPDU down to the PHY layer.

virtual void	ForwardPsduDown (Ptr< const WifiPsdu > psdu, WifiTxVector &txVector)
	Forward a PSDU down to the PHY layer.

Ptr< BlockAckManager >	GetBaManager (uint8_t tid) const
	Get the Block Ack Manager handling the given TID.

virtual Time	GetPsduDurationId (Time txDuration, const WifiTxParameters &txParams) const
	Compute how to set the Duration/ID field of PSDUs that do not include fragments.

virtual Ptr< WifiPsdu >	GetWifiPsdu (Ptr< WifiMpdu > mpdu, const WifiTxVector &txVector) const
	Get a PSDU containing the given MPDU.

virtual void	MissedBlockAck (Ptr< WifiPsdu > psdu, const WifiTxVector &txVector, bool &resetCw)
	Take necessary actions when a BlockAck is missed, such as scheduling a BlockAckReq frame or the retransmission of the unacknowledged frames.

virtual bool	NeedSetupBlockAck (Mac48Address recipient, uint8_t tid)
	A Block Ack agreement needs to be established with the given recipient for the given TID if it does not already exist (or exists and is in state RESET) and:

void	NotifyPacketDiscarded (Ptr< const WifiMpdu > mpdu) override
	Pass the given MPDU, discarded because of the max retry limit was reached, to the MPDU dropped callback.

void	NotifyReceivedNormalAck (Ptr< WifiMpdu > mpdu) override
	Notify other components that an MPDU was acknowledged.

virtual void	NotifyTxToEdca (Ptr< const WifiPsdu > psdu) const
	Notify the transmission of the given PSDU to the EDCAF associated with the AC the PSDU belongs to.

void	ProtectionCompleted () override
	Transmit prepared frame upon successful protection mechanism.

void	ReceiveMpdu (Ptr< const WifiMpdu > mpdu, RxSignalInfo rxSignalInfo, const WifiTxVector &txVector, bool inAmpdu) override
	This method handles the reception of an MPDU (possibly included in an A-MPDU)

void	ReleaseSequenceNumbers (Ptr< const WifiPsdu > psdu) const override
	Make the sequence numbers of MPDUs included in the given PSDU available again if the MPDUs have never been transmitted.

void	RetransmitMpduAfterMissedAck (Ptr< WifiMpdu > mpdu) const override
	Retransmit an MPDU that was not acknowledged.

bool	SendAddBaRequest (Mac48Address recipient, uint8_t tid, uint16_t startingSeq, uint16_t timeout, bool immediateBAck, Time availableTime)
	Sends an ADDBA Request to establish a block ack agreement with STA addressed by recipient for TID tid.

void	SendBlockAck (const RecipientBlockAckAgreement &agreement, Time durationId, WifiTxVector &blockAckTxVector, double rxSnr)
	Create a BlockAck frame with header equal to blockAck and start its transmission.

virtual bool	SendDataFrame (Ptr< WifiMpdu > peekedItem, Time availableTime, bool initialFrame)
	Given a non-broadcast QoS data frame, prepare the PSDU to transmit by attempting A-MSDU and A-MPDU aggregation (if enabled), while making sure that the frame exchange (possibly including protection and acknowledgment) is completed within the given available time.

virtual bool	SendMpduFromBaManager (Ptr< WifiMpdu > mpdu, Time availableTime, bool initialFrame)
	If the given MPDU contains a BlockAckReq frame (the duration of which plus the response fits within the given available time, if the latter is not Time::Min() and this is not the initial frame of a TXOP), transmit the frame and return true.

void	SendPsduWithProtection (Ptr< WifiPsdu > psdu, WifiTxParameters &txParams)
	Send a PSDU (A-MPDU or BlockAckReq frame) requesting a BlockAck frame or a BlockAckReq frame followed by a BlockAck frame for the acknowledgment.

void	TransmissionSucceeded () override
	Take necessary actions upon a transmission success.

Protected Member Functions inherited from ns3::QosFrameExchangeManager
virtual void	ClearTxopHolderIfNeeded ()
	Clear the TXOP holder if the NAV counted down to zero (includes the case of NAV reset).

void	DoDispose () override
	Destructor implementation.

void	ForwardMpduDown (Ptr< WifiMpdu > mpdu, WifiTxVector &txVector) override
	Forward an MPDU down to the PHY layer.

Time	GetCtsToSelfDurationId (const WifiTxVector &ctsTxVector, Time txDuration, Time response) const override
	Compute how to set the Duration/ID field of a CTS-to-self frame to send to protect a frame transmitted with the given TX vector.

Time	GetFrameDurationId (const WifiMacHeader &header, uint32_t size, const WifiTxParameters &txParams, Ptr< Packet > fragmentedPacket) const override
	Compute how to set the Duration/ID field of a frame being transmitted with the given TX parameters.

Time	GetRtsDurationId (const WifiTxVector &rtsTxVector, Time txDuration, Time response) const override
	Compute how to set the Duration/ID field of an RTS frame to send to protect a frame transmitted with the given TX vector.

void	NavResetTimeout () override
	Reset the NAV upon expiration of the NAV reset timer.

void	PifsRecovery ()
	Perform a PIFS recovery as a response to transmission failure within a TXOP.

void	PostProcessFrame (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector) override
	Perform actions that are possibly needed after receiving any frame, independently of whether the frame is addressed to this station (e.g., setting the NAV or the TXOP holder).

void	PreProcessFrame (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector) override
	Perform actions that are possibly needed when receiving any frame, independently of whether the frame is addressed to this station (e.g., storing buffer status reports).

void	ReceiveMpdu (Ptr< const WifiMpdu > mpdu, RxSignalInfo rxSignalInfo, const WifiTxVector &txVector, bool inAmpdu) override
	This method handles the reception of an MPDU (possibly included in an A-MPDU)

virtual bool	SendCfEndIfNeeded ()
	Send a CF-End frame to indicate the completion of the TXOP, provided that the remaining duration is long enough to transmit this frame.

virtual void	SetTxopHolder (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector)
	Set the TXOP holder, if needed, based on the received frame.

virtual bool	StartFrameExchange (Ptr< QosTxop > edca, Time availableTime, bool initialFrame)
	Start a frame exchange (including protection frames and acknowledgment frames as needed) that fits within the given availableTime (if different than Time::Min()).

virtual bool	StartTransmission (Ptr< QosTxop > edca, Time txopDuration)
	Request the FrameExchangeManager to start a frame exchange sequence.

void	TransmissionFailed () override
	Take necessary actions upon a transmission failure.

void	TransmissionSucceeded () override
	Take necessary actions upon a transmission success.

void	UpdateNav (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector) override
	Update the NAV, if needed, based on the Duration/ID of the given psdu.

Protected Member Functions inherited from ns3::FrameExchangeManager
virtual void	CtsTimeout (Ptr< WifiMpdu > rts, const WifiTxVector &txVector)
	Called when the CTS timeout expires.

virtual void	DequeueMpdu (Ptr< const WifiMpdu > mpdu)
	Dequeue the given MPDU from the queue in which it is stored.

void	DoCtsTimeout (Ptr< WifiPsdu > psdu)
	Take required actions when the CTS timer fired after sending an RTS to protect the given PSDU expires.

void	DoDispose () override
	Destructor implementation.

void	DoSendCtsAfterRts (const WifiMacHeader &rtsHdr, WifiTxVector &ctsTxVector, double rtsSnr)
	Send CTS after receiving RTS.

virtual void	EndReceiveAmpdu (Ptr< const WifiPsdu > psdu, const RxSignalInfo &rxSignalInfo, const WifiTxVector &txVector, const std::vector< bool > &perMpduStatus)
	This method is called when the reception of an A-MPDU including multiple MPDUs is completed.

virtual void	FinalizeMacHeader (Ptr< const WifiPsdu > psdu)
	Finalize the MAC header of the MPDUs in the given PSDU before transmission.

virtual void	ForwardMpduDown (Ptr< WifiMpdu > mpdu, WifiTxVector &txVector)
	Forward an MPDU down to the PHY layer.

virtual Time	GetCtsToSelfDurationId (const WifiTxVector &ctsTxVector, Time txDuration, Time response) const
	Compute how to set the Duration/ID field of a CTS-to-self frame to send to protect a frame transmitted with the given TX vector.

Ptr< WifiMpdu >	GetFirstFragmentIfNeeded (Ptr< WifiMpdu > mpdu)
	Fragment the given MPDU if needed.

virtual Time	GetFrameDurationId (const WifiMacHeader &header, uint32_t size, const WifiTxParameters &txParams, Ptr< Packet > fragmentedPacket) const
	Compute how to set the Duration/ID field of a frame being transmitted with the given TX parameters.

Ptr< WifiMpdu >	GetNextFragment ()
	Get the next fragment of the current MSDU.

virtual uint32_t	GetPsduSize (Ptr< const WifiMpdu > mpdu, const WifiTxVector &txVector) const
	Get the size in bytes of the given MPDU, which is to be transmitted with the given TXVECTOR.

virtual Time	GetRtsDurationId (const WifiTxVector &rtsTxVector, Time txDuration, Time response) const
	Compute how to set the Duration/ID field of an RTS frame to send to protect a frame transmitted with the given TX vector.

virtual Time	GetTxDuration (uint32_t ppduPayloadSize, Mac48Address receiver, const WifiTxParameters &txParams) const
	Get the updated TX duration of the frame associated with the given TX parameters if the size of the PSDU addressed to the given receiver becomes ppduPayloadSize.

Ptr< WifiRemoteStationManager >	GetWifiRemoteStationManager () const

virtual void	NavResetTimeout ()
	Reset the NAV upon expiration of the NAV reset timer.

virtual void	NormalAckTimeout (Ptr< WifiMpdu > mpdu, const WifiTxVector &txVector)
	Called when the Ack timeout expires.

virtual void	NotifyChannelReleased (Ptr< Txop > txop)
	Notify the given Txop that channel has been released.

virtual void	NotifyPacketDiscarded (Ptr< const WifiMpdu > mpdu)
	Pass the given MPDU, discarded because of the max retry limit was reached, to the MPDU dropped callback.

virtual void	NotifyReceivedNormalAck (Ptr< WifiMpdu > mpdu)
	Notify other components that an MPDU was acknowledged.

virtual void	PostProcessFrame (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector)
	Perform actions that are possibly needed after receiving any frame, independently of whether the frame is addressed to this station (e.g., setting the NAV or the TXOP holder).

virtual void	PreProcessFrame (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector)
	Perform actions that are possibly needed when receiving any frame, independently of whether the frame is addressed to this station (e.g., storing buffer status reports).

virtual void	ProtectionCompleted ()
	Transmit prepared frame upon successful protection mechanism.

virtual void	ReceivedNormalAck (Ptr< WifiMpdu > mpdu, const WifiTxVector &txVector, const WifiTxVector &ackTxVector, const RxSignalInfo &rxInfo, double snr)
	Perform the actions needed when a Normal Ack is received.

virtual void	ReceiveMpdu (Ptr< const WifiMpdu > mpdu, RxSignalInfo rxSignalInfo, const WifiTxVector &txVector, bool inAmpdu)
	This method handles the reception of an MPDU (possibly included in an A-MPDU)

virtual void	ReleaseSequenceNumbers (Ptr< const WifiPsdu > psdu) const
	Make the sequence numbers of MPDUs included in the given PSDU available again if the MPDUs have never been transmitted.

virtual void	Reset ()
	Reset this frame exchange manager.

virtual void	RetransmitMpduAfterMissedAck (Ptr< WifiMpdu > mpdu) const
	Retransmit an MPDU that was not acknowledged.

void	SendCtsAfterRts (const WifiMacHeader &rtsHdr, WifiMode rtsTxMode, double rtsSnr)
	Send CTS after receiving RTS.

void	SendCtsToSelf (const WifiTxParameters &txParams)
	Send CTS for a CTS-to-self mechanism.

void	SendMpduWithProtection (Ptr< WifiMpdu > mpdu, WifiTxParameters &txParams)
	Send an MPDU with the given TX parameters (with the specified protection).

void	SendNormalAck (const WifiMacHeader &hdr, const WifiTxVector &dataTxVector, double dataSnr)
	Send Normal Ack.

void	SendRts (const WifiTxParameters &txParams)
	Send RTS to begin RTS-CTS-Data-Ack transaction.

virtual void	StartProtection (const WifiTxParameters &txParams)
	Start the protection mechanism indicated by the given TX parameters.

virtual void	TransmissionFailed ()
	Take necessary actions upon a transmission failure.

virtual void	TransmissionSucceeded ()
	Take necessary actions upon a transmission success.

virtual void	UpdateNav (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector)
	Update the NAV, if needed, based on the Duration/ID of the given psdu.

void	UpdateTxDuration (Mac48Address receiver, WifiTxParameters &txParams) const
	Update the TX duration field of the given TX parameters after that the PSDU addressed to the given receiver has changed.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Additional Inherited Members
Public Types inherited from ns3::FrameExchangeManager
typedef Callback< void, Ptr< const WifiMpdu > >	AckedMpdu
	typedef for a callback to invoke when an MPDU is successfully acknowledged.

typedef Callback< void, WifiMacDropReason, Ptr< const WifiMpdu > >	DroppedMpdu
	typedef for a callback to invoke when an MPDU is dropped.

Protected Types inherited from ns3::HtFrameExchangeManager
typedef std::pair< Mac48Address, uint8_t >	AgreementKey
	agreement key typedef (MAC address and TID)

Protected Attributes inherited from ns3::HeFrameExchangeManager
Ptr< ApWifiMac >	m_apMac
	MAC pointer (null if not an AP)

Time	m_intraBssNavEnd
	intra-BSS NAV expiration time

EventId	m_intraBssNavResetEvent
	the event to reset the intra-BSS NAV after an RTS

Ptr< StaWifiMac >	m_staMac
	MAC pointer (null if not a STA)

WifiTxVector	m_trigVector
	the TRIGVECTOR

Protected Attributes inherited from ns3::HtFrameExchangeManager
Ptr< MpduAggregator >	m_mpduAggregator
	A-MPDU aggregator.

Ptr< MsduAggregator >	m_msduAggregator
	A-MSDU aggregator.

std::map< AgreementKey, Ptr< WifiMpdu > >	m_pendingAddBaResp
	pending ADDBA_RESPONSE frames indexed by agreement key

Protected Attributes inherited from ns3::QosFrameExchangeManager
Ptr< QosTxop >	m_edca
	the EDCAF that gained channel access

bool	m_setQosQueueSize
	whether to set the Queue Size subfield of the QoS Control field of QoS data frames

std::optional< Mac48Address >	m_txopHolder
	MAC address of the TXOP holder.

Protected Attributes inherited from ns3::FrameExchangeManager
AckedMpdu	m_ackedMpduCallback
	the acknowledged MPDU callback

uint16_t	m_allowedWidth
	the allowed width in MHz for the current transmission

Mac48Address	m_bssid
	BSSID address (Mac48Address)

Ptr< ChannelAccessManager >	m_channelAccessManager
	the channel access manager

Ptr< Txop >	m_dcf
	the DCF/EDCAF that gained channel access

DroppedMpdu	m_droppedMpduCallback
	the dropped MPDU callback

uint8_t	m_linkId
	the ID of the link this object is associated with

Ptr< WifiMac >	m_mac
	the MAC layer on this station

Time	m_navEnd
	NAV expiration time.

EventId	m_navResetEvent
	the event to reset the NAV after an RTS

Ptr< WifiPhy >	m_phy
	the PHY layer on this station

bool	m_promisc
	Flag if the device is operating in promiscuous mode.

std::set< Mac48Address >	m_protectedStas
	STAs that have replied to an RTS in this TXOP.

Ptr< MacRxMiddle >	m_rxMiddle
	the MAC RX Middle on this station

Mac48Address	m_self
	the MAC address of this device

std::set< Mac48Address >	m_sentRtsTo
	the STA(s) which we sent an RTS to (waiting for CTS)

Ptr< MacTxMiddle >	m_txMiddle
	the MAC TX Middle on this station

WifiTxTimer	m_txTimer
	the timer set upon frame transmission

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

Detailed Description

EhtFrameExchangeManager handles the frame exchange sequences for EHT stations.

Introspection did not find any typical Config paths.

No Attributes are defined for this type.

Attributes defined in parent class ns3::QosFrameExchangeManager

PifsRecovery: Perform a PIFS recovery as a response to transmission failure within a TXOP
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
SetQueueSize: Whether to set the Queue Size subfield of the QoS Control field of QoS data frames sent by non-AP stations
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: constructwriteread

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

Definition at line 35 of file eht-frame-exchange-manager.h.

Constructor & Destructor Documentation

◆ EhtFrameExchangeManager()

ns3::EhtFrameExchangeManager::EhtFrameExchangeManager ( )

Definition at line 49 of file eht-frame-exchange-manager.cc.

References NS_LOG_FUNCTION.

◆ ~EhtFrameExchangeManager()

ns3::EhtFrameExchangeManager::~EhtFrameExchangeManager ( )

override

Definition at line 54 of file eht-frame-exchange-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ CreateAliasIfNeeded()

Ptr< WifiMpdu > ns3::EhtFrameExchangeManager::CreateAliasIfNeeded ( Ptr< WifiMpdu > mpdu ) const

overridevirtual

Create an alias of the given MPDU for transmission by this Frame Exchange Manager.

This is required by 11be MLDs to support translation of MAC addresses. For single link devices, the given MPDU is simply returned.

Parameters

mpdu	the given MPDU

Returns: the alias of the given MPDU for transmission on this link

Reimplemented from ns3::QosFrameExchangeManager.

Definition at line 68 of file eht-frame-exchange-manager.cc.

References ns3::QosFrameExchangeManager::CreateAliasIfNeeded(), ns3::FrameExchangeManager::GetAddress(), ns3::WifiRemoteStationManager::GetAffiliatedStaAddress(), ns3::WifiMac::GetNLinks(), ns3::FrameExchangeManager::GetWifiRemoteStationManager(), ns3::FrameExchangeManager::m_linkId, ns3::FrameExchangeManager::m_mac, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ EmlsrSwitchToListening()

void ns3::EhtFrameExchangeManager::EmlsrSwitchToListening	(	const Mac48Address &	address,
		const Time &	delay
	)

protected

This method is intended to be called when an AP MLD detects that an EMLSR client previously involved in the current TXOP will start waiting for the transition delay interval (to switch back to listening operation) after the given delay.

This method blocks the transmissions on all the EMLSR links of the given EMLSR client until the transition delay advertised by the EMLSR client expires.

Parameters

address	the link MAC address of the given EMLSR client
delay	the given delay

Definition at line 189 of file eht-frame-exchange-manager.cc.

References ns3::Time::As(), ns3::WifiMac::BlockUnicastTxOnLinks(), ns3::CommonInfoBasicMle::DecodeEmlsrTransitionDelay(), ns3::WifiRemoteStationManager::GetEmlsrEnabled(), ns3::WifiRemoteStationManager::GetMldAddress(), ns3::WifiMac::GetNLinks(), ns3::WifiRemoteStationManager::GetStationEmlCapabilities(), ns3::FrameExchangeManager::GetWifiRemoteStationManager(), ns3::WifiMac::GetWifiRemoteStationManager(), ns3::FrameExchangeManager::m_linkId, ns3::FrameExchangeManager::m_mac, NS_ASSERT, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::WifiMac::UnblockUnicastTxOnLinks(), ns3::Time::US, ns3::USING_OTHER_EMLSR_LINK, and ns3::WAITING_EMLSR_TRANSITION_DELAY.

Referenced by ForwardPsduDown(), and ForwardPsduMapDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ForwardPsduDown()

void ns3::EhtFrameExchangeManager::ForwardPsduDown	(	Ptr< const WifiPsdu >	psdu,
		WifiTxVector &	txVector
	)

overrideprotectedvirtual

Forward a PSDU down to the PHY layer.

Also, notify the Block Ack Manager of the transmission of the constituent MPDUs.

Parameters

psdu	the PSDU to forward down
txVector	the TXVECTOR used to transmit the MPDU

Reimplemented from ns3::HtFrameExchangeManager.

Definition at line 111 of file eht-frame-exchange-manager.cc.

References ns3::WifiPhy::CalculateTxDuration(), EmlsrSwitchToListening(), ns3::HtFrameExchangeManager::ForwardPsduDown(), ns3::WifiRemoteStationManager::GetAssociationId(), GetEmlsrSwitchToListening(), ns3::WifiPhy::GetPhyBand(), ns3::WifiPhy::GetPhyEntity(), ns3::WifiTxVector::GetPreambleType(), ns3::FrameExchangeManager::GetWifiRemoteStationManager(), ns3::HeFrameExchangeManager::m_apMac, ns3::FrameExchangeManager::m_phy, ns3::FrameExchangeManager::m_protectedStas, NS_LOG_FUNCTION, ns3::WifiTxVector::SetSigBMode(), ns3::WIFI_MOD_CLASS_EHT, and ns3::WIFI_PREAMBLE_EHT_MU.

Here is the call graph for this function:

◆ ForwardPsduMapDown()

void ns3::EhtFrameExchangeManager::ForwardPsduMapDown	(	WifiConstPsduMap	psduMap,
		WifiTxVector &	txVector
	)

overrideprotectedvirtual

Forward a map of PSDUs down to the PHY layer.

Parameters

psduMap	the map of PSDUs to transmit
txVector	the TXVECTOR used to transmit the MU PPDU

Reimplemented from ns3::HeFrameExchangeManager.

Definition at line 153 of file eht-frame-exchange-manager.cc.

References ns3::WifiPhy::CalculateTxDuration(), EmlsrSwitchToListening(), ns3::HeFrameExchangeManager::ForwardPsduMapDown(), ns3::WifiRemoteStationManager::GetAssociationId(), GetEmlsrSwitchToListening(), ns3::WifiPhy::GetPhyBand(), ns3::FrameExchangeManager::GetWifiRemoteStationManager(), ns3::HeFrameExchangeManager::m_apMac, ns3::FrameExchangeManager::m_phy, ns3::FrameExchangeManager::m_protectedStas, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetEmlsrSwitchToListening()

bool ns3::EhtFrameExchangeManager::GetEmlsrSwitchToListening	(	Ptr< const WifiPsdu >	psdu,
		uint16_t	aid,
		const Mac48Address &	address
	)		const

Parameters

psdu	the given PSDU
aid	the AID of an EMLSR client
address	the link MAC address of an EMLSR client

Returns: whether the EMLSR client having the given AID and MAC address shall switch back to the listening operation when receiving the given PSDU

Definition at line 350 of file eht-frame-exchange-manager.cc.

References ns3::CtrlTriggerHeader::end(), ns3::CtrlBAckResponseHeader::FindPerAidTidInfoWithAid(), ns3::CtrlTriggerHeader::FindUserInfoWithAid(), ns3::CtrlBAckResponseHeader::IsMultiSta(), NS_LOG_FUNCTION, and ns3::PeekPointer().

Referenced by ForwardPsduDown(), and ForwardPsduMapDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMostRecentRssi()

std::optional< double > ns3::EhtFrameExchangeManager::GetMostRecentRssi ( const Mac48Address & address ) const

overridevirtual

Get the RSSI (in dBm) of the most recent packet received from the station having the given address.

If there is no such information for the given station and the station is affiliated with an MLD, return the RSSI (in dBm) of the most recent packet received from another station of the same MLD.

Parameters

address of the remote station