HeFrameExchangeManager handles the frame exchange sequences for HE stations. More...

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

Inheritance diagram for ns3::HeFrameExchangeManager:

Collaboration diagram for ns3::HeFrameExchangeManager:

Public Member Functions
	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.

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.

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

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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 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
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, 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	RxStartIndication (WifiTxVector txVector, Time psduDuration) override

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

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, std::size_t nSolicitedStations)
	Take the necessary actions after that some TB PPDUs are missing in response to Trigger Frame.

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

virtual void	RxStartIndication (WifiTxVector txVector, Time psduDuration)

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.

Protected Attributes
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

Private Member Functions
void	ReceiveBasicTrigger (const CtrlTriggerHeader &trigger, const WifiMacHeader &hdr)
	Take the necessary actions when receiving a Basic Trigger Frame.

void	ReceiveMuBarTrigger (const CtrlTriggerHeader &trigger, uint8_t tid, Time durationId, double snr)
	Respond to a MU-BAR Trigger Frame (if permitted by UL MU CS mechanism).

void	SendPsduMap ()
	Send the current PSDU map as a DL MU PPDU.

Private Attributes
EventId	m_multiStaBaEvent
	Sending a Multi-STA BlockAck event.

Ptr< MultiUserScheduler >	m_muScheduler
	Multi-user Scheduler (HE APs only)

MuSnrTag	m_muSnrTag
	Tag to attach to Multi-STA BlockAck frames.

WifiPsduMap	m_psduMap
	the A-MPDU being transmitted

Ptr< WifiMpdu >	m_triggerFrame
	Trigger Frame being sent.

bool	m_triggerFrameInAmpdu
	True if the received A-MPDU contains an MU-BAR.

WifiTxParameters	m_txParams
	the TX parameters for the current PPDU

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)

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

HeFrameExchangeManager handles the frame exchange sequences for HE 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 1632 bytes (on a 64-bit architecture).

Definition at line 67 of file he-frame-exchange-manager.h.

Constructor & Destructor Documentation

◆ HeFrameExchangeManager()

ns3::HeFrameExchangeManager::HeFrameExchangeManager ( )

Definition at line 75 of file he-frame-exchange-manager.cc.

References NS_LOG_FUNCTION.

◆ ~HeFrameExchangeManager()

ns3::HeFrameExchangeManager::~HeFrameExchangeManager ( )

override

Definition at line 82 of file he-frame-exchange-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ BlockAckAfterTbPpduTimeout()

void ns3::HeFrameExchangeManager::BlockAckAfterTbPpduTimeout	(	Ptr< WifiPsdu >	psdu,
		const WifiTxVector &	txVector
	)

protectedvirtual

Take the necessary actions after that a Block Ack is missing after a TB PPDU solicited through a Trigger Frame.

Parameters

psdu	the PSDU in the TB PPDU
txVector	the TXVECTOR used to transmit the TB PPDU

Definition at line 1356 of file he-frame-exchange-manager.cc.

References NS_LOG_FUNCTION.

◆ BlockAcksInTbPpduTimeout()

void ns3::HeFrameExchangeManager::BlockAcksInTbPpduTimeout	(	WifiPsduMap *	psduMap,
		std::size_t	nSolicitedStations
	)

protectedvirtual

Take the necessary actions after that some BlockAck frames are missing in response to a DL MU PPDU.

This method must not be called if all the expected BlockAck frames were received.

Parameters

psduMap	a pointer to PSDU map transmitted in a DL MU PPDU
nSolicitedStations	the number of stations solicited to send a TB PPDU

Definition at line 1284 of file he-frame-exchange-manager.cc.

References NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by SendPsduMap().

Here is the caller graph for this function:

◆ BlockAckTimeout()

void ns3::HeFrameExchangeManager::BlockAckTimeout	(	Ptr< WifiPsdu >	psdu,
		const WifiTxVector &	txVector
	)

overrideprotectedvirtual

Called when the BlockAck timeout expires.

Parameters

psdu	the PSDU (BlockAckReq or A-MPDU) that solicited a BlockAck response
txVector	the TXVECTOR used to send the PSDU that solicited a BlockAck response

Reimplemented from ns3::HtFrameExchangeManager.

Definition at line 1400 of file he-frame-exchange-manager.cc.

References NS_LOG_FUNCTION, and ns3::PeekPointer().

Here is the call graph for this function:

◆ CalculateAcknowledgmentTime()

void ns3::HeFrameExchangeManager::CalculateAcknowledgmentTime ( WifiAcknowledgment * acknowledgment ) const

overridevirtual

Calculate the time required to acknowledge a frame according to the given acknowledgment method.

The acknowledgment time is stored in the acknowledgment object itself.

Parameters

acknowledgment the acknowledgment method

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1014 of file he-frame-exchange-manager.cc.

References ns3::WifiAcknowledgment::acknowledgmentTime, ns3::GetAckSize(), ns3::GetBlockAckRequestSize(), ns3::GetBlockAckSize(), ns3::GetMuBarSize(), ns3::WifiAcknowledgment::method, NS_ABORT_IF, NS_ASSERT, NS_LOG_FUNCTION, ns3::Seconds(), and ns3::WIFI_MOD_CLASS_VHT.

Referenced by SendPsduMapWithProtection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateProtectionTime()

void ns3::HeFrameExchangeManager::CalculateProtectionTime ( WifiProtection * protection ) const

overridevirtual

Calculate the time required to protect a frame according to the given protection method.

The protection time is stored in the protection object itself.

Parameters

protection the protection method

Reimplemented from ns3::FrameExchangeManager.

Definition at line 983 of file he-frame-exchange-manager.cc.

References ns3::GetCtsSize(), ns3::WifiMacHeader::GetSize(), ns3::WifiProtection::method, NS_ASSERT, NS_LOG_FUNCTION, and ns3::WIFI_MAC_CTL_TRIGGER.

Here is the call graph for this function:

◆ ClearTxopHolderIfNeeded()

void ns3::HeFrameExchangeManager::ClearTxopHolderIfNeeded ( )

overrideprotectedvirtual

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

Reimplemented from ns3::QosFrameExchangeManager.

Definition at line 2068 of file he-frame-exchange-manager.cc.

References NS_LOG_FUNCTION.

◆ CtsAfterMuRtsTimeout()

void ns3::HeFrameExchangeManager::CtsAfterMuRtsTimeout	(	Ptr< WifiMpdu >	muRts,
		const WifiTxVector &	txVector
	)

protectedvirtual

Called when no CTS frame is received after an MU-RTS.

Parameters

muRts	the MU-RTS that solicited CTS responses
txVector	the TXVECTOR used to transmit the MU-RTS frame

Reimplemented in ns3::EhtFrameExchangeManager.

Definition at line 398 of file he-frame-exchange-manager.cc.

References ns3::FrameExchangeManager::CtsTimeout(), ns3::HtFrameExchangeManager::DequeuePsdu(), ns3::FrameExchangeManager::GetWifiRemoteStationManager(), ns3::QosFrameExchangeManager::m_edca, ns3::FrameExchangeManager::m_linkId, m_psduMap, ns3::FrameExchangeManager::m_sentRtsTo, ns3::HtFrameExchangeManager::NotifyPacketDiscarded(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::PeekPointer(), ns3::HtFrameExchangeManager::ReleaseSequenceNumbers(), ns3::Txop::ResetCw(), ns3::QosFrameExchangeManager::TransmissionFailed(), and ns3::Txop::UpdateFailedCw().

Referenced by ns3::EhtFrameExchangeManager::CtsAfterMuRtsTimeout(), and SendMuRts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CtsTimeout()

void ns3::HeFrameExchangeManager::CtsTimeout	(	Ptr< WifiMpdu >	rts,
		const WifiTxVector &	txVector
	)

overrideprotectedvirtual

Called when the CTS timeout expires.

Parameters

rts	the RTS that solicited a CTS response
txVector	the TXVECTOR used to transmit the RTS frame

Reimplemented from ns3::FrameExchangeManager.

Definition at line 477 of file he-frame-exchange-manager.cc.

References ns3::FrameExchangeManager::CtsTimeout(), ns3::FrameExchangeManager::DoCtsTimeout(), m_psduMap, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoDispose()

void ns3::HeFrameExchangeManager::DoDispose ( )

overrideprotectedvirtual

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

Definition at line 117 of file he-frame-exchange-manager.cc.

References ns3::EventId::Cancel(), ns3::WifiTxParameters::Clear(), ns3::Object::DoDispose(), m_apMac, m_multiStaBaEvent, m_muScheduler, m_psduMap, m_staMac, m_txParams, and NS_LOG_FUNCTION.

Referenced by ns3::EhtFrameExchangeManager::DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EndReceiveAmpdu()

void ns3::HeFrameExchangeManager::EndReceiveAmpdu	(	Ptr< const WifiPsdu >	psdu,
		const RxSignalInfo &	rxSignalInfo,
		const WifiTxVector &	txVector,
		const std::vector< bool > &	perMpduStatus
	)

overrideprotectedvirtual

This method is called when the reception of an A-MPDU including multiple MPDUs is completed.

Parameters

psdu	the received PSDU
rxSignalInfo	the info on the received signal (

See also: RxSignalInfo)

Parameters

txVector	TxVector of the received PSDU
perMpduStatus	per MPDU reception status

Reimplemented from ns3::FrameExchangeManager.

Definition at line 2643 of file he-frame-exchange-manager.cc.

References ns3::WifiUlMuMultiStaBa::baType, ns3::WifiTxVector::GetHeMuUserInfoMap(), ns3::WifiTxVector::IsUlMu(), ns3::BlockAckType::m_bitmapLen, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_WARN, and ns3::RxSignalInfo::snr.

Here is the call graph for this function:

◆ ForwardPsduMapDown()

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

protectedvirtual

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 in ns3::EhtFrameExchangeManager.

Definition at line 897 of file he-frame-exchange-manager.cc.

References ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetModulationClass(), ns3::WifiTxVector::GetPreambleType(), ns3::IsDlMu(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiTxVector::SetAggregation(), and ns3::WifiTxVector::SetSigBMode().

Referenced by ns3::EhtFrameExchangeManager::ForwardPsduMapDown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCtsModeAfterMuRts()

WifiMode ns3::HeFrameExchangeManager::GetCtsModeAfterMuRts ( ) const

protected

Returns: the mode used to transmit a CTS after an MU-RTS.

Definition at line 1175 of file he-frame-exchange-manager.cc.

References ns3::WIFI_PHY_BAND_2_4GHZ.

Referenced by GetMuRtsDurationId().

Here is the caller graph for this function:

◆ GetCtsTxVectorAfterMuRts()

WifiTxVector ns3::HeFrameExchangeManager::GetCtsTxVectorAfterMuRts	(	const CtrlTriggerHeader &	trigger,
		uint16_t	staId
	)		const

protected

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.

Parameters

trigger	the MU-RTS Trigger Frame
staId	the station ID for MU

Returns: the TXVECTOR to use to send a CTS frame

Definition at line 1184 of file he-frame-exchange-manager.cc.

References ns3::CtrlTriggerHeader::end(), ns3::CtrlTriggerHeader::FindUserInfoWithAid(), NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by SendMuRts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHeTbTxVector()

WifiTxVector ns3::HeFrameExchangeManager::GetHeTbTxVector	(	CtrlTriggerHeader	trigger,
		Mac48Address	triggerSender
	)		const

protected

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.

Note that this method should only be called by non-AP stations only.

Parameters

trigger	the received Trigger frame
triggerSender	the MAC address of the AP sending the Trigger frame

Returns: TXVECTOR for the HE TB PPDU frame

Get the transmit power to use for an HE TB PPDU considering:

the transmit power used by the AP to send the Trigger Frame (TF), obtained from the AP TX Power subfield of the Common Info field of the TF.
the target uplink RSSI expected by the AP for the triggered HE TB PPDU, obtained from the UL Target RSSI subfield of the User Info field of the TF.
the RSSI of the PPDU containing the TF, typically logged by the WifiRemoteStationManager upon reception of the TF from the AP.

It is assumed that path loss is symmetric (i.e. uplink path loss is equivalent to the measured downlink path loss);

Refer to section 27.3.14.2 (Power pre-correction) of 802.11ax Draft 4.0 for more details.

Definition at line 1441 of file he-frame-exchange-manager.cc.

References ns3::CtrlTriggerHeader::end(), ns3::CtrlTriggerHeader::FindUserInfoWithAid(), ns3::CtrlTriggerHeader::GetApTxPower(), ns3::CtrlTriggerHeader::GetHeTbTxVector(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_LOGIC, NS_LOG_WARN, ns3::WifiTxVector::SetBssColor(), and ns3::WifiTxVector::SetTxPowerLevel().

Here is the call graph for this function:

◆ GetMostRecentRssi()

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

virtual

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

Parameters

address of the remote station

Returns: the RSSI (in dBm) of the most recent packet received from the remote station

Reimplemented in ns3::EhtFrameExchangeManager.

Definition at line 1522 of file he-frame-exchange-manager.cc.

Referenced by ns3::EhtFrameExchangeManager::GetMostRecentRssi().

Here is the caller graph for this function:

◆ GetMuRtsDurationId()

Time ns3::HeFrameExchangeManager::GetMuRtsDurationId	(	uint32_t	muRtsSize,
		const WifiTxVector &	muRtsTxVector,
		Time	txDuration,
		Time	response
	)		const

protectedvirtual

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.

Parameters

muRtsSize	the size of the MU-RTS Trigger Frame in bytes
muRtsTxVector	the TX vector used to send the MU-RTS Trigger Frame
txDuration	the TX duration of the data frame
response	the time taken by the response (acknowledgment) to the data frame

Returns: the computed Duration/ID value for the MU-RTS Trigger Frame

Definition at line 317 of file he-frame-exchange-manager.cc.

References ns3::WifiPhy::CalculateTxDuration(), GetCtsModeAfterMuRts(), ns3::WifiPhy::GetPhyBand(), ns3::QosTxop::GetRemainingTxop(), ns3::FrameExchangeManager::GetRtsDurationId(), ns3::Txop::GetTxopLimit(), ns3::Time::IsZero(), ns3::QosFrameExchangeManager::m_edca, ns3::FrameExchangeManager::m_linkId, ns3::FrameExchangeManager::m_phy, NS_LOG_FUNCTION, ns3::Seconds(), and ns3::WifiTxVector::SetMode().

Referenced by SendMuRts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPsduTo()

Ptr< WifiPsdu > ns3::HeFrameExchangeManager::GetPsduTo	(	Mac48Address	to,
		const WifiPsduMap &	psduMap
	)

static

Get the PSDU in the given PSDU map that is addressed to the given MAC address, if any, or a null pointer, otherwise.

Parameters

to	the MAC address
psduMap	the PSDU map

Returns: the PSDU, if any, or a null pointer, otherwise

Definition at line 463 of file he-frame-exchange-manager.cc.

Referenced by SendPsduMap().

Here is the caller graph for this function:

◆ GetTrigVector()

WifiTxVector ns3::HeFrameExchangeManager::GetTrigVector ( const CtrlTriggerHeader & trigger ) const

protected

Get the TRIGVECTOR that the MAC has to pass to the PHY when transmitting the given Trigger Frame.

Parameters

trigger the given Trigger Frame

Returns: the TRIGVECTOR

Definition at line 1423 of file he-frame-exchange-manager.cc.

References ns3::CtrlTriggerHeader::GetGuardInterval(), ns3::CtrlTriggerHeader::GetUlBandwidth(), ns3::CtrlTriggerHeader::GetUlLength(), ns3::CtrlTriggerHeader::GetVariant(), ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetGuardInterval(), ns3::WifiTxVector::SetHeMuUserInfo(), ns3::WifiTxVector::SetLength(), ns3::WifiTxVector::SetPreambleType(), ns3::WIFI_PREAMBLE_EHT_TB, and ns3::WIFI_PREAMBLE_HE_TB.

Here is the call graph for this function:

◆ GetTxDuration()

Time ns3::HeFrameExchangeManager::GetTxDuration	(	uint32_t	ppduPayloadSize,
		Mac48Address	receiver,
		const WifiTxParameters &	txParams
	)		const

overrideprotectedvirtual

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.

Parameters

ppduPayloadSize	the new PSDU size
receiver	the MAC address of the receiver of the PSDU
txParams	the TX parameters

Returns: the updated TX duration

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1219 of file he-frame-exchange-manager.cc.

References ns3::WifiTxVector::IsDlMu(), ns3::WifiTxVector::IsMu(), ns3::WifiTxVector::IsUlMu(), ns3::WifiTxParameters::m_acknowledgment, ns3::WifiTxParameters::m_txDuration, ns3::WifiTxParameters::m_txVector, NS_ASSERT, NS_ASSERT_MSG, and ns3::WifiDlMuAggregateTf::stationsReplyingWithBlockAck.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::HeFrameExchangeManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 66 of file he-frame-exchange-manager.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IntraBssNavResetTimeout()

void ns3::HeFrameExchangeManager::IntraBssNavResetTimeout ( )

protectedvirtual

Reset the intra-BSS NAV upon expiration of the intra-BSS NAV reset timer.

Reimplemented in ns3::EhtFrameExchangeManager.

Definition at line 2089 of file he-frame-exchange-manager.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::EhtFrameExchangeManager::IntraBssNavResetTimeout().

Here is the caller graph for this function:

◆ IsIntraBssPpdu()

bool ns3::HeFrameExchangeManager::IsIntraBssPpdu	(	Ptr< const WifiPsdu >	psdu,
		const WifiTxVector &	txVector
	)		const

Return whether the received frame is classified as intra-BSS.

It is assumed that this station is already associated with an AP.

Parameters

psdu	the received PSDU
txVector	TX vector of the received PSDU

Returns: true if the received frame is classified as intra-BSS, false otherwise (the received frame is classified as inter-BSS or it cannot be classified as intra-BSS or inter-BSS)

Definition at line 1925 of file he-frame-exchange-manager.cc.

References ns3::WifiTxVector::GetBssColor(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ NavResetTimeout()

void ns3::HeFrameExchangeManager::NavResetTimeout ( )

overrideprotectedvirtual

Reset the NAV upon expiration of the NAV reset timer.

Reimplemented from ns3::FrameExchangeManager.

Definition at line 2078 of file he-frame-exchange-manager.cc.

References NS_LOG_FUNCTION.

Referenced by ns3::EhtFrameExchangeManager::NavResetTimeout().

Here is the caller graph for this function:

◆ NormalAckTimeout()

void ns3::HeFrameExchangeManager::NormalAckTimeout	(	Ptr< WifiMpdu >	mpdu,
		const WifiTxVector &	txVector
	)

overrideprotectedvirtual

Called when the Ack timeout expires.

Parameters

mpdu	the MPDU that solicited a Normal Ack response
txVector	the TXVECTOR used to transmit the frame soliciting the Normal Ack

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1376 of file he-frame-exchange-manager.cc.

References NS_LOG_FUNCTION, and ns3::PeekPointer().

Here is the call graph for this function:

◆ PostProcessFrame()

void ns3::HeFrameExchangeManager::PostProcessFrame	(	Ptr< const WifiPsdu >	psdu,
		const WifiTxVector &	txVector
	)

overrideprotectedvirtual

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

Parameters

psdu	the received PSDU
txVector	TX vector of the received PSDU

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1551 of file he-frame-exchange-manager.cc.

References ns3::CtrlTriggerHeader::end(), ns3::CtrlTriggerHeader::FindUserInfoWithAid(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetDuration(), ns3::CtrlTriggerHeader::IsMuRts(), NS_LOG_FUNCTION, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetDuration(), ns3::WifiMacHeader::SetType(), and ns3::WIFI_MAC_CTL_RTS.

Referenced by ns3::EhtFrameExchangeManager::PostProcessFrame().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrepareMuBar()

Ptr< WifiMpdu > ns3::HeFrameExchangeManager::PrepareMuBar	(	const WifiTxVector &	responseTxVector,
		std::map< uint16_t, CtrlBAckRequestHeader >	recipients
	)		const

protected

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.

Note that the number of recipients must match the number of users addressed by the given TXVECTOR.

Parameters

responseTxVector	the given TXVECTOR
recipients	the list of BlockAckReq headers indexed by the station's AID

Returns: the MPDU containing the built MU-BAR

Definition at line 930 of file he-frame-exchange-manager.cc.

References ns3::WifiTxVector::GetHeMuUserInfoMap(), ns3::CtrlTriggerHeader::GetNUserInfoFields(), ns3::CtrlTriggerHeader::GetUlLength(), NS_ASSERT, NS_LOG_FUNCTION, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::CtrlTriggerHeader::SetCsRequired(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetNoMoreFragments(), ns3::WifiMacHeader::SetNoRetry(), ns3::WifiMacHeader::SetType(), and ns3::WIFI_MAC_CTL_TRIGGER.

Referenced by SendPsduMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProtectionCompleted()

void ns3::HeFrameExchangeManager::ProtectionCompleted ( )

overrideprotectedvirtual

Transmit prepared frame upon successful protection mechanism.

Reimplemented from ns3::FrameExchangeManager.

Definition at line 303 of file he-frame-exchange-manager.cc.

References ns3::FrameExchangeManager::m_protectedStas, m_psduMap, ns3::FrameExchangeManager::m_sentRtsTo, NS_LOG_FUNCTION, ns3::FrameExchangeManager::ProtectionCompleted(), and SendPsduMap().

Here is the call graph for this function:

◆ ReceiveBasicTrigger()

void ns3::HeFrameExchangeManager::ReceiveBasicTrigger	(	const CtrlTriggerHeader &	trigger,
		const WifiMacHeader &	hdr
	)

private

Take the necessary actions when receiving a Basic Trigger Frame.

Parameters

trigger	the Basic Trigger Frame content
hdr	the MAC header of the Basic Trigger Frame

Definition at line 1720 of file he-frame-exchange-manager.cc.

References ns3::WifiTxParameters::Clear(), ns3::CtrlTriggerHeader::FindUserInfoWithAid(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetDuration(), ns3::CtrlTriggerHeader::GetUlLength(), ns3::CtrlTriggerHeader::IsBasic(), ns3::WifiTxParameters::m_txVector, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::wifiAcList.

Here is the call graph for this function:

◆ ReceiveMpdu()

void ns3::HeFrameExchangeManager::ReceiveMpdu	(	Ptr< const WifiMpdu >	mpdu,
		RxSignalInfo	rxSignalInfo,
		const WifiTxVector &	txVector,
		bool	inAmpdu
	)

overrideprotectedvirtual

This method handles the reception of an MPDU (possibly included in an A-MPDU)

Parameters

mpdu	the received MPDU
rxSignalInfo	the info on the received signal (

See also: RxSignalInfo)

Parameters

txVector	TxVector of the received PSDU
inAmpdu	true if the MPDU is part of an A-MPDU

Reimplemented from ns3::FrameExchangeManager.

Definition at line 2167 of file he-frame-exchange-manager.cc.

Referenced by ns3::EhtFrameExchangeManager::ReceiveMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReceiveMuBarTrigger()

void ns3::HeFrameExchangeManager::ReceiveMuBarTrigger	(	const CtrlTriggerHeader &	trigger,
		uint8_t	tid,
		Time	durationId,
		double	snr
	)

private

Respond to a MU-BAR Trigger Frame (if permitted by UL MU CS mechanism).

Parameters

trigger	the Basic Trigger Frame content
tid	the TID requested for us in the MU-BAR Trigger Frame
durationId	the Duration/ID field of the MPDU carrying the Trigger Frame
snr	the receive SNR

Definition at line 1899 of file he-frame-exchange-manager.cc.

References ns3::Time::As(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ RecordSentMuRtsTo()

void ns3::HeFrameExchangeManager::RecordSentMuRtsTo ( const WifiTxParameters & txParams )

protected

Record the stations being solicited by an MU-RTS TF.

Parameters

txParams the TX parameters for the data frame protected by the MU-RTS TF.

Definition at line 282 of file he-frame-exchange-manager.cc.

References ns3::ApWifiMac::GetStaList(), m_apMac, ns3::FrameExchangeManager::m_linkId, ns3::WifiTxParameters::m_protection, ns3::FrameExchangeManager::m_sentRtsTo, ns3::WifiProtection::MU_RTS_CTS, NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by StartProtection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Reset()

void ns3::HeFrameExchangeManager::Reset ( )

overrideprotectedvirtual

Reset this frame exchange manager.

Reimplemented from ns3::FrameExchangeManager.

Definition at line 88 of file he-frame-exchange-manager.cc.

References ns3::EventId::Cancel(), ns3::EventId::IsRunning(), m_intraBssNavEnd, m_intraBssNavResetEvent, ns3::Simulator::Now(), NS_LOG_FUNCTION, and ns3::FrameExchangeManager::Reset().

Here is the call graph for this function:

◆ RxStartIndication()

void ns3::HeFrameExchangeManager::RxStartIndication	(	WifiTxVector	txVector,
		Time	psduDuration
	)

overrideprotectedvirtual

Parameters

txVector	the TXVECTOR decoded from PHY header.
psduDuration	the duration of the PSDU that is about to be received.

This method is typically invoked by the lower PHY layer to notify the MAC layer that the reception of a PSDU is starting. This is equivalent to the PHY-RXSTART primitive. If the reception is correct for at least one MPDU of the PSDU the Receive method will be called after psduDuration.

Reimplemented from ns3::FrameExchangeManager.

Definition at line 108 of file he-frame-exchange-manager.cc.

References ns3::Time::As(), ns3::EventId::Cancel(), m_intraBssNavResetEvent, ns3::Time::MS, NS_LOG_FUNCTION, and ns3::FrameExchangeManager::RxStartIndication().

Referenced by ns3::EhtFrameExchangeManager::RxStartIndication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendCtsAfterMuRts()

void ns3::HeFrameExchangeManager::SendCtsAfterMuRts	(	const WifiMacHeader &	muRtsHdr,
		const CtrlTriggerHeader &	trigger,
		double	muRtsSnr
	)

protected

Send CTS after receiving an MU-RTS.

Parameters

muRtsHdr	the MAC header of the received MU-RTS
trigger	the MU-RTS Trigger Frame header
muRtsSnr	the SNR of the MU-RTS in linear scale

Definition at line 1596 of file he-frame-exchange-manager.cc.

References NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::WifiTxVector::SetTriggerResponding().

Here is the call graph for this function:

◆ SendMultiStaBlockAck()

void ns3::HeFrameExchangeManager::SendMultiStaBlockAck	(	const WifiTxParameters &	txParams,
		Time	durationId
	)

protected

Send a Multi-STA Block Ack frame after the reception of some TB PPDUs.

Parameters

txParams	the TX parameters for the Trigger Frame that solicited the TB PPDUs
durationId	the Duration/ID field of the HE TB PPDU that elicited the Multi-STA Block Ack response

In a BlockAck frame transmitted in response to a frame carried in HE TB PPDU under single protection settings, the Duration/ID field is set to the value obtained from the Duration/ID field of the frame that elicited the response minus the time, in microseconds between the end of the PPDU carrying the frame that elicited the response and the end of the PPDU carrying the BlockAck frame. Under multiple protection settings, the Duration/ID field in a BlockAck frame transmitted in response to a frame carried in HE TB PPDU is set according to the multiple protection settings defined in 9.2.5.2. (Sec. 9.2.5.7 of 802.11ax-2021)

Definition at line 1616 of file he-frame-exchange-manager.cc.

References ns3::Time::As(), ns3::GetBlockAckSize(), ns3::CtrlBAckResponseHeader::GetStartingSequence(), ns3::WifiTxParameters::m_acknowledgment, Max, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Seconds(), ns3::CtrlBAckResponseHeader::SetAckType(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::CtrlBAckResponseHeader::SetAid11(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::CtrlBAckResponseHeader::SetTidInfo(), ns3::CtrlBAckResponseHeader::SetType(), ns3::WifiMacHeader::SetType(), and ns3::WIFI_MAC_CTL_BACKRESP.

Here is the call graph for this function:

◆ SendMuRts()

void ns3::HeFrameExchangeManager::SendMuRts ( const WifiTxParameters & txParams )

protectedvirtual

Send an MU-RTS to begin an MU-RTS/CTS frame exchange protecting an MU PPDU.

Parameters

txParams the TX parameters for the data frame

Reimplemented in ns3::EhtFrameExchangeManager.

Definition at line 341 of file he-frame-exchange-manager.cc.

References ns3::WifiPhy::CalculatePhyPreambleAndHeaderDuration(), ns3::WifiPhy::CalculateTxDuration(), CtsAfterMuRtsTimeout(), ns3::HtFrameExchangeManager::ForwardMpduDown(), ns3::Mac48Address::GetBroadcast(), GetCtsTxVectorAfterMuRts(), GetMuRtsDurationId(), ns3::WifiPhy::GetPhyBand(), ns3::WifiPhy::GetSifs(), ns3::WifiPhy::GetSlot(), ns3::WifiTxTimer::IsRunning(), ns3::WifiTxParameters::m_acknowledgment, ns3::FrameExchangeManager::m_channelAccessManager, ns3::FrameExchangeManager::m_phy, ns3::WifiTxParameters::m_protection, ns3::FrameExchangeManager::m_self, ns3::FrameExchangeManager::m_sentRtsTo, ns3::WifiTxParameters::m_txDuration, ns3::FrameExchangeManager::m_txTimer, ns3::Time::Min(), ns3::WifiProtection::MU_RTS_CTS, ns3::ChannelAccessManager::NotifyCtsTimeoutStartNow(), NS_ASSERT, NS_LOG_FUNCTION, ns3::WifiTxTimer::Set(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetNoMoreFragments(), ns3::WifiMacHeader::SetNoRetry(), ns3::WifiMacHeader::SetType(), timeout, ns3::WifiTxTimer::WAIT_CTS_AFTER_MU_RTS, and ns3::WIFI_MAC_CTL_TRIGGER.

Referenced by ns3::EhtFrameExchangeManager::SendMuRts(), and StartProtection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendPsduMap()

void ns3::HeFrameExchangeManager::SendPsduMap ( )

private

Send the current PSDU map as a DL MU PPDU.

Definition at line 512 of file he-frame-exchange-manager.cc.

Referenced by ProtectionCompleted().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendPsduMapWithProtection()

void ns3::HeFrameExchangeManager::SendPsduMapWithProtection	(	WifiPsduMap	psduMap,
		WifiTxParameters &	txParams
	)

protected

Send a map of PSDUs as a DL MU PPDU.

Note that both psduMap and txParams are moved to m_psduMap and m_txParams, respectively, and hence are left in an undefined state.

Parameters

psduMap	the map of PSDUs to send
txParams	the TX parameters to use to transmit the PSDUs

Definition at line 204 of file he-frame-exchange-manager.cc.

References CalculateAcknowledgmentTime(), ns3::HePhy::ConvertLSigLengthToHeTbPpduDuration(), ns3::WifiPhy::GetPhyBand(), ns3::WifiPhy::GetSifs(), ns3::IsTrigger(), ns3::WifiTxVector::IsUlMu(), ns3::WifiTxParameters::m_acknowledgment, ns3::FrameExchangeManager::m_linkId, m_muScheduler, ns3::FrameExchangeManager::m_phy, m_psduMap, m_txParams, ns3::WifiTxParameters::m_txVector, ns3::Time::Min(), ns3::WifiAcknowledgment::NONE, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::PeekPointer(), ns3::WifiAckManager::SetQosAckPolicy(), StartProtection(), and ns3::WifiAcknowledgment::UL_MU_MULTI_STA_BA.

Referenced by StartFrameExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendQosNullFramesInTbPpdu()

void ns3::HeFrameExchangeManager::SendQosNullFramesInTbPpdu	(	const CtrlTriggerHeader &	trigger,
		const WifiMacHeader &	hdr
	)

protected

Send QoS Null frames in response to a Basic or BSRP Trigger Frame.

The number of QoS Null frames that are actually aggregated depends on the available time as indicated by the Trigger Frame and is at most 8 (one QoS Null frame per TID).

Parameters

trigger	the Basic or BSRP Trigger Frame content
hdr	the MAC header of the Basic or BSRP Trigger Frame

Definition at line 1817 of file he-frame-exchange-manager.cc.

Here is the call graph for this function:

◆ SetMultiUserScheduler()

void ns3::HeFrameExchangeManager::SetMultiUserScheduler ( const Ptr< MultiUserScheduler > muScheduler )

Set the Multi-user Scheduler associated with this Frame Exchange Manager.

Parameters

muScheduler the Multi-user Scheduler associated with this Frame Exchange Manager

Definition at line 130 of file he-frame-exchange-manager.cc.

References ns3::WifiMac::GetHeConfiguration(), m_apMac, ns3::FrameExchangeManager::m_mac, m_muScheduler, NS_ABORT_MSG_IF, and NS_ASSERT.

Here is the call graph for this function:

◆ SetTargetRssi()

void ns3::HeFrameExchangeManager::SetTargetRssi ( CtrlTriggerHeader & trigger ) const

virtual

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.

Parameters

trigger the given Trigger Frame

Definition at line 1528 of file he-frame-exchange-manager.cc.

References NS_ASSERT, NS_LOG_FUNCTION, and ns3::CtrlTriggerHeader::SetApTxPower().

Here is the call graph for this function:

◆ SetTxopHolder()

void ns3::HeFrameExchangeManager::SetTxopHolder	(	Ptr< const WifiPsdu >	psdu,
		const WifiTxVector &	txVector
	)

overridevirtual

Set the TXOP holder, if needed, based on the received frame.

Parameters

psdu	the received PSDU
txVector	TX vector of the received PSDU

Reimplemented from ns3::QosFrameExchangeManager.

Definition at line 2100 of file he-frame-exchange-manager.cc.

References ns3::WifiTxVector::IsUlMu(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetWifiMac()

void ns3::HeFrameExchangeManager::SetWifiMac ( const Ptr< WifiMac > mac )

overridevirtual

Set the MAC layer to use.

Parameters

mac	the MAC layer to use

Reimplemented from ns3::FrameExchangeManager.

Definition at line 100 of file he-frame-exchange-manager.cc.

References m_apMac, m_staMac, and ns3::FrameExchangeManager::SetWifiMac().

Here is the call graph for this function:

◆ StartFrameExchange()

bool ns3::HeFrameExchangeManager::StartFrameExchange	(	Ptr< QosTxop >	edca,
		Time	availableTime,
		bool	initialFrame
	)

overridevirtual

Start a frame exchange (including protection frames and acknowledgment frames as needed) that fits within the given availableTime (if different than Time::Min()).

Parameters

edca	the EDCAF which has been granted the opportunity to transmit
availableTime	the amount of time allowed for the frame exchange. Pass Time::Min() in case the TXOP limit is null
initialFrame	true if the frame being transmitted is the initial frame of the TXOP. This is used to determine whether the TXOP limit can be exceeded

Returns: true if a frame exchange is started, false otherwise

Reimplemented from ns3::QosFrameExchangeManager.

Definition at line 140 of file he-frame-exchange-manager.cc.

References ns3::MultiUserScheduler::DL_MU_TX, ns3::WifiMac::GetBaAgreementEstablishedAsOriginator(), ns3::HtFrameExchangeManager::GetBar(), ns3::VhtFrameExchangeManager::GetWifiPsdu(), ns3::FrameExchangeManager::m_allowedWidth, ns3::FrameExchangeManager::m_linkId, ns3::FrameExchangeManager::m_mac, m_muScheduler, NS_LOG_DEBUG, NS_LOG_FUNCTION, SendPsduMapWithProtection(), ns3::HtFrameExchangeManager::StartFrameExchange(), ns3::SU_STA_ID, ns3::MultiUserScheduler::SU_TX, and ns3::MultiUserScheduler::UL_MU_TX.

Here is the call graph for this function:

◆ StartProtection()

void ns3::HeFrameExchangeManager::StartProtection ( const WifiTxParameters & txParams )

overrideprotectedvirtual

Start the protection mechanism indicated by the given TX parameters.

Parameters

txParams the TX parameters

Reimplemented from ns3::FrameExchangeManager.

Definition at line 263 of file he-frame-exchange-manager.cc.

References ns3::WifiTxParameters::m_protection, m_psduMap, ns3::WifiProtection::MU_RTS_CTS, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, RecordSentMuRtsTo(), ns3::WifiProtection::RTS_CTS, SendMuRts(), and ns3::FrameExchangeManager::StartProtection().

Referenced by SendPsduMapWithProtection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TbPpduTimeout()

void ns3::HeFrameExchangeManager::TbPpduTimeout	(	WifiPsduMap *	psduMap,
		std::size_t	nSolicitedStations
	)

protectedvirtual

Take the necessary actions after that some TB PPDUs are missing in response to Trigger Frame.

This method must not be called if all the expected TB PPDUs were received.

Parameters

psduMap	a pointer to PSDU map transmitted in a DL MU PPDU
nSolicitedStations	the number of stations solicited to send a TB PPDU

Definition at line 1255 of file he-frame-exchange-manager.cc.

References ns3::IsTrigger(), NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ TransmissionSucceeded()

void ns3::HeFrameExchangeManager::TransmissionSucceeded ( )

overrideprotectedvirtual

Take necessary actions upon a transmission success.

A non-QoS station transmits the next fragment, if any, or releases the channel, otherwise.

Reimplemented from ns3::FrameExchangeManager.

Definition at line 495 of file he-frame-exchange-manager.cc.

References ns3::WifiTxTimer::GetStasExpectedToRespond(), ns3::FrameExchangeManager::m_protectedStas, ns3::FrameExchangeManager::m_txTimer, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::FrameExchangeManager::TransmissionSucceeded().

Referenced by ns3::EhtFrameExchangeManager::TransmissionSucceeded().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UlMuCsMediumIdle()

bool ns3::HeFrameExchangeManager::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.

Parameters

trigger the Trigger Frame soliciting a response

Returns: true if CS is not required or the UL MU CS mechanism indicates that the medium is idle, false otherwise

Definition at line 2124 of file he-frame-exchange-manager.cc.

References ns3::CtrlTriggerHeader::end(), ns3::CtrlTriggerHeader::FindUserInfoWithAid(), ns3::CtrlTriggerHeader::GetCsRequired(), ns3::CtrlTriggerHeader::GetUlBandwidth(), ns3::CtrlTriggerHeader::IsMuRts(), NS_ASSERT_MSG, and NS_LOG_DEBUG.

Here is the call graph for this function:

◆ UpdateNav()

void ns3::HeFrameExchangeManager::UpdateNav	(	Ptr< const WifiPsdu >	psdu,
		const WifiTxVector &	txVector
	)

overrideprotectedvirtual

Update the NAV, if needed, based on the Duration/ID of the given psdu.

Parameters

psdu	the received PSDU
txVector	TxVector of the received PSDU

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1990 of file he-frame-exchange-manager.cc.

References ns3::GetCtsSize(), ns3::WifiTxVector::GetMode(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ VirtualCsMediumIdle()

bool ns3::HeFrameExchangeManager::VirtualCsMediumIdle ( ) const

overridevirtual

Returns: true if the virtual CS indication is that the medium is idle

Reimplemented from ns3::FrameExchangeManager.

Definition at line 2115 of file he-frame-exchange-manager.cc.

Member Data Documentation

◆ m_apMac

Ptr<ApWifiMac> ns3::HeFrameExchangeManager::m_apMac

protected

MAC pointer (null if not an AP)

Definition at line 343 of file he-frame-exchange-manager.h.

◆ m_intraBssNavEnd

Time ns3::HeFrameExchangeManager::m_intraBssNavEnd

protected

intra-BSS NAV expiration time

Definition at line 346 of file he-frame-exchange-manager.h.

Referenced by Reset().

◆ m_intraBssNavResetEvent

EventId ns3::HeFrameExchangeManager::m_intraBssNavResetEvent

protected

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

Definition at line 347 of file he-frame-exchange-manager.h.

Referenced by Reset(), and RxStartIndication().

◆ m_multiStaBaEvent

EventId ns3::HeFrameExchangeManager::m_multiStaBaEvent

private

Sending a Multi-STA BlockAck event.

Definition at line 380 of file he-frame-exchange-manager.h.

Referenced by DoDispose().

◆ m_muScheduler

Ptr<MultiUserScheduler> ns3::HeFrameExchangeManager::m_muScheduler

private

Multi-user Scheduler (HE APs only)

Definition at line 378 of file he-frame-exchange-manager.h.

Referenced by DoDispose(), SendPsduMapWithProtection(), SetMultiUserScheduler(), and StartFrameExchange().

◆ m_muSnrTag

MuSnrTag ns3::HeFrameExchangeManager::m_muSnrTag

private

Tag to attach to Multi-STA BlockAck frames.

Definition at line 381 of file he-frame-exchange-manager.h.

◆ m_psduMap

WifiPsduMap ns3::HeFrameExchangeManager::m_psduMap

private

the A-MPDU being transmitted

Definition at line 376 of file he-frame-exchange-manager.h.

Referenced by CtsAfterMuRtsTimeout(), CtsTimeout(), DoDispose(), ProtectionCompleted(), SendPsduMap(), SendPsduMapWithProtection(), and StartProtection().

◆ m_staMac

Ptr<StaWifiMac> ns3::HeFrameExchangeManager::m_staMac

protected

MAC pointer (null if not a STA)

Definition at line 344 of file he-frame-exchange-manager.h.

◆ m_triggerFrame

Ptr<WifiMpdu> ns3::HeFrameExchangeManager::m_triggerFrame

private

Trigger Frame being sent.

Definition at line 379 of file he-frame-exchange-manager.h.

Referenced by SendPsduMap().

◆ m_triggerFrameInAmpdu

bool ns3::HeFrameExchangeManager::m_triggerFrameInAmpdu

private

True if the received A-MPDU contains an MU-BAR.

Definition at line 382 of file he-frame-exchange-manager.h.

◆ m_trigVector

WifiTxVector ns3::HeFrameExchangeManager::m_trigVector

protected

the TRIGVECTOR

Definition at line 345 of file he-frame-exchange-manager.h.

Referenced by SendPsduMap().

◆ m_txParams

WifiTxParameters ns3::HeFrameExchangeManager::m_txParams

private

the TX parameters for the current PPDU

Definition at line 377 of file he-frame-exchange-manager.h.

Referenced by DoDispose(), SendPsduMap(), and SendPsduMapWithProtection().

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

src/wifi/model/he/he-frame-exchange-manager.h
src/wifi/model/he/he-frame-exchange-manager.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes defined in parent class ns3::QosFrameExchangeManager

Constructor & Destructor Documentation

◆ HeFrameExchangeManager()

◆ ~HeFrameExchangeManager()

Member Function Documentation

◆ BlockAckAfterTbPpduTimeout()

◆ BlockAcksInTbPpduTimeout()

◆ BlockAckTimeout()

◆ CalculateAcknowledgmentTime()

◆ CalculateProtectionTime()

◆ ClearTxopHolderIfNeeded()

◆ CtsAfterMuRtsTimeout()

◆ CtsTimeout()

◆ DoDispose()

◆ EndReceiveAmpdu()

◆ ForwardPsduMapDown()

◆ GetCtsModeAfterMuRts()

◆ GetCtsTxVectorAfterMuRts()

◆ GetHeTbTxVector()

◆ GetMostRecentRssi()

◆ GetMuRtsDurationId()

◆ GetPsduTo()

◆ GetTrigVector()

◆ GetTxDuration()

◆ GetTypeId()

◆ IntraBssNavResetTimeout()

◆ IsIntraBssPpdu()

◆ NavResetTimeout()

◆ NormalAckTimeout()

◆ PostProcessFrame()

◆ PrepareMuBar()

◆ ProtectionCompleted()

◆ ReceiveBasicTrigger()

◆ ReceiveMpdu()

◆ ReceiveMuBarTrigger()

◆ RecordSentMuRtsTo()

◆ Reset()

◆ RxStartIndication()

◆ SendCtsAfterMuRts()

◆ SendMultiStaBlockAck()

◆ SendMuRts()

◆ SendPsduMap()

◆ SendPsduMapWithProtection()

◆ SendQosNullFramesInTbPpdu()

◆ SetMultiUserScheduler()

◆ SetTargetRssi()

◆ SetTxopHolder()

◆ SetWifiMac()

◆ StartFrameExchange()

◆ StartProtection()

◆ TbPpduTimeout()

◆ TransmissionSucceeded()

◆ UlMuCsMediumIdle()

◆ UpdateNav()

◆ VirtualCsMediumIdle()

Member Data Documentation

◆ m_apMac

◆ m_intraBssNavEnd

◆ m_intraBssNavResetEvent

◆ m_multiStaBaEvent

◆ m_muScheduler

◆ m_muSnrTag

◆ m_psduMap

◆ m_staMac

◆ m_triggerFrame

◆ m_triggerFrameInAmpdu

◆ m_trigVector

◆ m_txParams