A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::HeFrameExchangeManager Class Reference

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.
 
std::optional< Mac48AddressFindTxopHolder (const WifiMacHeader &hdr, const WifiTxVector &txVector) override
 Determine the holder of the TXOP, if possible, based on the received frame.
 
virtual std::optional< dBm_uGetMostRecentRssi (const Mac48Address &address) const
 Get the RSSI of the most recent packet received from the station having the given address.
 
std::set< Mac48AddressGetTfRecipients (const CtrlTriggerHeader &trigger) const
 Get the (link) address of the non-AP stations solicited by the given Trigger Frame.
 
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.
 
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
 
Ptr< WifiPsduGetWifiPsdu (Ptr< WifiMpdu > mpdu, const WifiTxVector &txVector) const override
 Get a PSDU containing the given MPDU.
 
- 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< WifiMpduGetBar (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< MpduAggregatorGetMpduAggregator () const
 Returns the aggregator used to construct A-MPDU subframes.
 
Ptr< MsduAggregatorGetMsduAggregator () 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< WifiMpduCreateAliasIfNeeded (Ptr< WifiMpdu > mpdu) const
 Create an alias of the given MPDU for transmission by this Frame Exchange Manager.
 
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, MHz_u 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
 
Ptr< WifiAckManagerGetAckManager () const
 Get the Acknowledgment Manager used by this node.
 
Mac48Address GetAddress () const
 Get the MAC address.
 
MHz_u GetAllowedWidth () const
 
Mac48Address GetBssid () const
 Get the Basic Service Set Identification.
 
std::optional< std::reference_wrapper< const OngoingRxInfo > > GetOngoingRxInfo () const
 
const std::set< Mac48Address > & GetProtectedStas () const
 
Ptr< WifiProtectionManagerGetProtectionManager () const
 Get the Protection Manager used by this node.
 
std::optional< std::reference_wrapper< const WifiMacHeader > > GetReceivedMacHdr () const
 
const WifiTxTimerGetWifiTxTimer () 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, const WifiTxVector &txVector, const 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 SetWifiPhy (const Ptr< WifiPhy > phy)
 Set the PHY layer to use.
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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, bool permissive=false) 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.
 
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< WifiPsduGetPsduTo (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 DoCtsAfterMuRtsTimeout (Ptr< WifiMpdu > muRts, const WifiTxVector &txVector, bool updateFailedCw)
 Called when no CTS frame is received after an MU-RTS.
 
void DoDispose () override
 Destructor implementation.
 
void DoTbPpduTimeout (WifiPsduMap *psduMap, std::size_t nSolicitedStations, bool updateFailedCw)
 Take the necessary actions after that some TB PPDUs are missing in response to Trigger Frame.
 
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< WifiMpduPrepareMuBar (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 immediately, if no protection was used, or in a SIFS, if protection was completed successfully.
 
virtual void ReceivedQosNullAfterBsrpTf (Mac48Address sender)
 Perform the actions required when receiving QoS Null frame(s) from the given sender after a BSRP Trigger Frame.
 
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 Reset () override
 Reset this frame exchange manager.
 
void RxStartIndication (WifiTxVector txVector, Time psduDuration) override
 
virtual 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.
 
virtual 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.
 
- Protected Member Functions inherited from ns3::HtFrameExchangeManager
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< BlockAckManagerGetBaManager (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 void MissedBlockAck (Ptr< WifiPsdu > psdu, const WifiTxVector &txVector)
 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 immediately, if no protection was used, or in a SIFS, if protection was completed successfully.
 
void ReceiveMgtAction (Ptr< const WifiMpdu > mpdu, const WifiTxVector &txVector)
 Process a received management action frame that relates to Block Ack agreement.
 
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, std::optional< Mac48Address > gcrGroupAddr=std::nullopt)
 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
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 (bool forceCurrentCw)
 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 bool StartTransmission (Ptr< QosTxop > edca, Time txopDuration)
 Request the FrameExchangeManager to start a frame exchange sequence.
 
void TransmissionFailed (bool forceCurrentCw=false) 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 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 DoSendCtsAfterRts (const WifiMacHeader &rtsHdr, WifiTxVector &ctsTxVector, double rtsSnr)
 Send CTS after receiving RTS.
 
Ptr< WifiMpduDropMpduIfRetryLimitReached (Ptr< WifiPsdu > psdu)
 Wrapper for the GetMpdusToDropOnTxFailure function of the remote station manager that additionally drops the MPDUs in the given PSDU that the remote station manager requested to drop.
 
Ptr< WifiMpduGetFirstFragmentIfNeeded (Ptr< WifiMpdu > mpdu)
 Fragment the given MPDU if needed.
 
Ptr< WifiMpduGetNextFragment ()
 Get the next fragment of the current MSDU.
 
Ptr< WifiRemoteStationManagerGetWifiRemoteStationManager () const
 
virtual void NotifyChannelReleased (Ptr< Txop > txop)
 Notify the given Txop that channel has been released.
 
virtual void PsduRxError (Ptr< const WifiPsdu > psdu)
 This method is called when the reception of a PSDU fails.
 
virtual void ReceivedMacHdr (const WifiMacHeader &macHdr, const WifiTxVector &txVector, Time psduDuration)
 Store information about the MAC header of the MPDU being received.
 
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 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.
 
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 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

Time m_intraBssNavEnd
 intra-BSS NAV expiration time
 
EventId m_intraBssNavResetEvent
 the event to reset the intra-BSS NAV after an RTS
 
WifiTxVector m_trigVector
 the TRIGVECTOR
 
- Protected Attributes inherited from ns3::HtFrameExchangeManager
Ptr< MpduAggregatorm_mpduAggregator
 A-MPDU aggregator.
 
Ptr< MsduAggregatorm_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< QosTxopm_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< Mac48Addressm_txopHolder
 MAC address of the TXOP holder.
 
- Protected Attributes inherited from ns3::FrameExchangeManager
AckedMpdu m_ackedMpduCallback
 the acknowledged MPDU callback
 
MHz_u m_allowedWidth
 the allowed width for the current transmission
 
Ptr< ApWifiMacm_apMac
 AP MAC layer pointer (null if not an AP)
 
Mac48Address m_bssid
 BSSID address (Mac48Address)
 
Ptr< ChannelAccessManagerm_channelAccessManager
 the channel access manager
 
Ptr< Txopm_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< WifiMacm_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< WifiPhym_phy
 the PHY layer on this station
 
bool m_promisc
 Flag if the device is operating in promiscuous mode.
 
bool m_protectedIfResponded
 whether a STA is assumed to be protected if replied to a frame requiring acknowledgment
 
std::set< Mac48Addressm_protectedStas
 STAs that have replied to an RTS in this TXOP.
 
Ptr< MacRxMiddlem_rxMiddle
 the MAC RX Middle on this station
 
Mac48Address m_self
 the MAC address of this device
 
std::set< Mac48Addressm_sentFrameTo
 the STA(s) to which we sent a frame requesting a response
 
std::set< Mac48Addressm_sentRtsTo
 the STA(s) which we sent an RTS to (waiting for CTS)
 
Ptr< StaWifiMacm_staMac
 STA MAC layer pointer (null if not a STA)
 
Ptr< MacTxMiddlem_txMiddle
 the MAC TX Middle on this station
 
Time m_txNav
 the TXNAV timer
 
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

bool m_continueTxopAfterBsrpTf
 whether to continue a TXOP a SIFS after the reception of responses to a BSRP TF when TXOP limit is zero
 
EventId m_multiStaBaEvent
 Sending a Multi-STA BlockAck event.
 
Ptr< MultiUserSchedulerm_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< WifiMpdum_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)
 

Detailed Description

HeFrameExchangeManager handles the frame exchange sequences for HE stations.

Config Paths

ns3::HeFrameExchangeManager is accessible through the following paths with Config::Set and Config::Connect:

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/FrameExchangeManagers/[i]/$ns3::HeFrameExchangeManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/FrameExchangeManagers/[i]/$ns3::VhtFrameExchangeManager/$ns3::HeFrameExchangeManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/FrameExchangeManagers/[i]/$ns3::HtFrameExchangeManager/$ns3::HeFrameExchangeManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/FrameExchangeManagers/[i]/$ns3::HtFrameExchangeManager/$ns3::VhtFrameExchangeManager/$ns3::HeFrameExchangeManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/FrameExchangeManagers/[i]/$ns3::QosFrameExchangeManager/$ns3::HeFrameExchangeManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/FrameExchangeManagers/[i]/$ns3::QosFrameExchangeManager/$ns3::VhtFrameExchangeManager/$ns3::HeFrameExchangeManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/FrameExchangeManagers/[i]/$ns3::QosFrameExchangeManager/$ns3::HtFrameExchangeManager/$ns3::HeFrameExchangeManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/FrameExchangeManagers/[i]/$ns3::QosFrameExchangeManager/$ns3::HtFrameExchangeManager/$ns3::VhtFrameExchangeManager/$ns3::HeFrameExchangeManager"

Attributes

  • ContinueTxopAfterBsrp: Whether to continue a TXOP a SIFS after the reception of responses to a BSRP Trigger Frame when TXOP limit is zero.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED

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
    • Support level: SUPPORTED
  • 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
    • Support level: SUPPORTED

Attributes defined in parent class ns3::FrameExchangeManager

  • ProtectedIfResponded: Whether a station is assumed to be protected if replied to a frame requiring acknowledgment. If a station is protected, subsequent transmissions to the same station in the same TXOP are not preceded by protection mechanisms.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Wifi

Size of this type is 2424 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ HeFrameExchangeManager()

ns3::HeFrameExchangeManager::HeFrameExchangeManager ( )

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

References NS_LOG_FUNCTION.

◆ ~HeFrameExchangeManager()

ns3::HeFrameExchangeManager::~HeFrameExchangeManager ( )
override

Definition at line 78 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
psduthe PSDU in the TB PPDU
txVectorthe TXVECTOR used to transmit the TB PPDU

Definition at line 1432 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
psduMapa pointer to PSDU map transmitted in a DL MU PPDU
nSolicitedStationsthe number of stations solicited to send a TB PPDU

Reimplemented in ns3::EhtFrameExchangeManager.

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

References NS_ASSERT, and NS_LOG_FUNCTION.

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

+ 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
psduthe PSDU (BlockAckReq or A-MPDU) that solicited a BlockAck response
txVectorthe TXVECTOR used to send the PSDU that solicited a BlockAck response

Reimplemented from ns3::HtFrameExchangeManager.

Definition at line 1473 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
acknowledgmentthe acknowledgment method

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1078 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
protectionthe protection method

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1047 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 2144 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
muRtsthe MU-RTS that solicited CTS responses
txVectorthe TXVECTOR used to transmit the MU-RTS frame

Reimplemented in ns3::EhtFrameExchangeManager.

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

References DoCtsAfterMuRtsTimeout(), and NS_LOG_FUNCTION.

Referenced by 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
rtsthe RTS that solicited a CTS response
txVectorthe TXVECTOR used to transmit the RTS frame

Reimplemented from ns3::FrameExchangeManager.

Definition at line 486 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:

◆ DoCtsAfterMuRtsTimeout()

void ns3::HeFrameExchangeManager::DoCtsAfterMuRtsTimeout ( Ptr< WifiMpdu > muRts,
const WifiTxVector & txVector,
bool updateFailedCw )
protected

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

Parameters
muRtsthe MU-RTS that solicited CTS responses
txVectorthe TXVECTOR used to transmit the MU-RTS frame
updateFailedCwwhether to update CW in case of retransmission after TX failure

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

References ns3::FrameExchangeManager::CtsTimeout(), ns3::FrameExchangeManager::DropMpduIfRetryLimitReached(), ns3::FrameExchangeManager::GetWifiRemoteStationManager(), ns3::FrameExchangeManager::m_linkId, m_psduMap, ns3::FrameExchangeManager::m_sentRtsTo, NS_LOG_FUNCTION, ns3::PeekPointer(), ns3::HtFrameExchangeManager::ReleaseSequenceNumbers(), and ns3::QosFrameExchangeManager::TransmissionFailed().

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

+ Here is the call graph for this function:
+ Here is the caller 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 105 of file he-frame-exchange-manager.cc.

References ns3::EventId::Cancel(), ns3::WifiTxParameters::Clear(), ns3::Object::DoDispose(), m_multiStaBaEvent, m_muScheduler, m_psduMap, ns3::FrameExchangeManager::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:

◆ DoTbPpduTimeout()

void ns3::HeFrameExchangeManager::DoTbPpduTimeout ( WifiPsduMap * psduMap,
std::size_t nSolicitedStations,
bool updateFailedCw )
protected

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
psduMapa pointer to PSDU map transmitted in a DL MU PPDU
nSolicitedStationsthe number of stations solicited to send a TB PPDU
updateFailedCwwhether to update CW in case the transmission failed

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

References ns3::CtrlTriggerHeader::IsBsrp(), ns3::IsTrigger(), NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

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

+ 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
psduthe received PSDU
rxSignalInfothe info on the received signal (
See also
RxSignalInfo)
Parameters
txVectorTxVector of the received PSDU
perMpduStatusper MPDU reception status

Reimplemented from ns3::FrameExchangeManager.

Definition at line 2703 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.

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

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

◆ FindTxopHolder()

std::optional< Mac48Address > ns3::HeFrameExchangeManager::FindTxopHolder ( const WifiMacHeader & hdr,
const WifiTxVector & txVector )
overridevirtual

Determine the holder of the TXOP, if possible, based on the received frame.

Parameters
hdrthe MAC header of an MPDU included in the received PSDU
txVectorTX vector of the received PSDU
Returns
the holder of the TXOP, if one was found

Reimplemented from ns3::QosFrameExchangeManager.

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

References ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::IsTrigger(), ns3::WifiTxVector::IsUlMu(), and NS_LOG_FUNCTION.

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

+ Here is the call graph for this function:
+ Here is the caller 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
psduMapthe map of PSDUs to transmit
txVectorthe TXVECTOR used to transmit the MU PPDU

Reimplemented in ns3::EhtFrameExchangeManager.

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

References ns3::WifiTxVector::GetChannelWidth(), ns3::WifiTxVector::GetModulationClass(), ns3::WifiTxVector::GetPreambleType(), ns3::IsDlMu(), Max, 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 1240 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
triggerthe MU-RTS Trigger Frame
staIdthe station ID for MU
Returns
the TXVECTOR to use to send a CTS frame

Definition at line 1249 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
triggerthe received Trigger frame
triggerSenderthe 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 1514 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< dBm_u > ns3::HeFrameExchangeManager::GetMostRecentRssi ( const Mac48Address & address) const
virtual

Get the RSSI of the most recent packet received from the station having the given address.

Parameters
addressof the remote station
Returns
the RSSI of the most recent packet received from the remote station

Reimplemented in ns3::EhtFrameExchangeManager.

Definition at line 1594 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
muRtsSizethe size of the MU-RTS Trigger Frame in bytes
muRtsTxVectorthe TX vector used to send the MU-RTS Trigger Frame
txDurationthe TX duration of the data frame
responsethe 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 330 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
tothe MAC address
psduMapthe PSDU map
Returns
the PSDU, if any, or a null pointer, otherwise

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

◆ GetTfRecipients()

std::set< Mac48Address > ns3::HeFrameExchangeManager::GetTfRecipients ( const CtrlTriggerHeader & trigger) const

Get the (link) address of the non-AP stations solicited by the given Trigger Frame.

Parameters
triggerthe given Trigger Frame
Returns
the (link) address of the non-AP stations solicited by the given Trigger Frame

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

References ns3::FrameExchangeManager::m_apMac, ns3::FrameExchangeManager::m_linkId, and NS_ASSERT_MSG.

Referenced by ns3::EhtFrameExchangeManager::ForwardPsduMapDown(), ns3::EhtFrameExchangeManager::SetIcfPaddingAndTxVector(), and StartProtection().

+ 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
triggerthe given Trigger Frame
Returns
the TRIGVECTOR

Definition at line 1496 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
ppduPayloadSizethe new PSDU size
receiverthe MAC address of the receiver of the PSDU
txParamsthe TX parameters
Returns
the updated TX duration

Reimplemented from ns3::FrameExchangeManager.

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

References ns3::GetMuBarSize(), ns3::WifiTxParameters::GetPsduInfo(), ns3::WifiTxVector::IsDlMu(), ns3::WifiTxVector::IsMu(), ns3::WifiTxVector::IsUlMu(), ns3::WifiTxParameters::m_acknowledgment, ns3::WifiTxParameters::m_txDuration, ns3::WifiTxParameters::m_txVector, and NS_ASSERT_MSG.

+ 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 55 of file he-frame-exchange-manager.cc.

References m_continueTxopAfterBsrpTf, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), and 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 2165 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
psduthe received PSDU
txVectorTX 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 2001 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 2154 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
mpduthe MPDU that solicited a Normal Ack response
txVectorthe TXVECTOR used to transmit the frame soliciting the Normal Ack

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1449 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
psduthe received PSDU
txVectorTX vector of the received PSDU

Reimplemented from ns3::FrameExchangeManager.

Definition at line 1623 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
responseTxVectorthe given TXVECTOR
recipientsthe list of BlockAckReq headers indexed by the station's AID
Returns
the MPDU containing the built MU-BAR

Definition at line 994 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.

+ Here is the call graph for this function:

◆ ProtectionCompleted()

void ns3::HeFrameExchangeManager::ProtectionCompleted ( )
overrideprotectedvirtual

Transmit prepared frame immediately, if no protection was used, or in a SIFS, if protection was completed successfully.

Reimplemented from ns3::FrameExchangeManager.

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

References ns3::WifiPhy::GetSifs(), ns3::Txop::GetTxopLimit(), ns3::Time::IsStrictlyPositive(), ns3::QosFrameExchangeManager::m_edca, ns3::FrameExchangeManager::m_linkId, m_muScheduler, ns3::FrameExchangeManager::m_phy, ns3::FrameExchangeManager::m_protectedStas, ns3::WifiTxParameters::m_protection, m_psduMap, ns3::FrameExchangeManager::m_sentRtsTo, m_txParams, ns3::WifiProtection::NONE, ns3::FrameExchangeManager::NotifyChannelReleased(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::FrameExchangeManager::ProtectionCompleted(), ns3::Simulator::Schedule(), ns3::QosFrameExchangeManager::SendCfEndIfNeeded(), and SendPsduMap().

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

+ Here is the call graph for this function:
+ Here is the caller 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
triggerthe Basic Trigger Frame content
hdrthe MAC header of the Basic Trigger Frame

Definition at line 1792 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:

◆ ReceivedQosNullAfterBsrpTf()

void ns3::HeFrameExchangeManager::ReceivedQosNullAfterBsrpTf ( Mac48Address sender)
protectedvirtual

Perform the actions required when receiving QoS Null frame(s) from the given sender after a BSRP Trigger Frame.

Parameters
senderthe MAC address of the given sender

Reimplemented in ns3::EhtFrameExchangeManager.

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

References NS_ASSERT, and NS_LOG_FUNCTION.

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

+ Here is the caller 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
mpduthe received MPDU
rxSignalInfothe info on the received signal (
See also
RxSignalInfo)
Parameters
txVectorTxVector of the received PSDU
inAmpdutrue if the MPDU is part of an A-MPDU

Reimplemented from ns3::FrameExchangeManager.

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

References ns3::WifiUlMuMultiStaBa::baType, ns3::CtrlTriggerHeader::end(), ns3::CtrlBAckResponseHeader::FindPerAidTidInfoWithAid(), ns3::CtrlTriggerHeader::FindUserInfoWithAid(), ns3::MuSnrTag::Get(), ns3::SnrTag::Get(), ns3::CtrlBAckResponseHeader::GetAckType(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr2(), ns3::CtrlBAckResponseHeader::GetBitmap(), ns3::WifiMacHeader::GetDuration(), ns3::WifiTxVector::GetHeMuUserInfoMap(), ns3::WifiTxVector::GetMode(), ns3::WifiMacHeader::GetQosAckPolicy(), ns3::WifiMacHeader::GetQosTid(), ns3::CtrlBAckRequestHeader::GetStartingSequence(), ns3::CtrlBAckRequestHeader::GetTidInfo(), ns3::CtrlBAckResponseHeader::GetTidInfo(), ns3::WifiMacHeader::HasData(), ns3::WifiMacHeader::IsAck(), ns3::CtrlTriggerHeader::IsBasic(), ns3::WifiMacHeader::IsBlockAck(), ns3::WifiMacHeader::IsBlockAckReq(), ns3::Mac48Address::IsBroadcast(), ns3::CtrlTriggerHeader::IsBsrp(), ns3::WifiMacHeader::IsCtl(), ns3::WifiMacHeader::IsCts(), ns3::CtrlTriggerHeader::IsMuBar(), ns3::CtrlBAckResponseHeader::IsMultiSta(), ns3::CtrlBAckRequestHeader::IsMultiTid(), ns3::CtrlTriggerHeader::IsMuRts(), ns3::WifiMacHeader::IsQosData(), ns3::WifiMacHeader::IsTrigger(), ns3::WifiTxVector::IsUlMu(), ns3::BlockAckType::m_bitmapLen, NS_ABORT_IF, NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_WARN, and ns3::RxSignalInfo::snr.

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
triggerthe Basic Trigger Frame content
tidthe TID requested for us in the MU-BAR Trigger Frame
durationIdthe Duration/ID field of the MPDU carrying the Trigger Frame
snrthe receive SNR

Definition at line 1975 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:

◆ Reset()

void ns3::HeFrameExchangeManager::Reset ( )
overrideprotectedvirtual

Reset this frame exchange manager.

Reimplemented from ns3::FrameExchangeManager.

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

References ns3::EventId::Cancel(), ns3::EventId::IsPending(), 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
txVectorthe TXVECTOR decoded from PHY header.
psduDurationthe 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 96 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 )
protectedvirtual

Send CTS after receiving an MU-RTS.

Parameters
muRtsHdrthe MAC header of the received MU-RTS
triggerthe MU-RTS Trigger Frame header
muRtsSnrthe SNR of the MU-RTS in linear scale

Reimplemented in ns3::EhtFrameExchangeManager.

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

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

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

+ Here is the call graph for this function:
+ Here is the caller 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
txParamsthe TX parameters for the Trigger Frame that solicited the TB PPDUs
durationIdthe 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 1688 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
txParamsthe TX parameters for the data frame

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

References ns3::WifiPhy::CalculatePhyPreambleAndHeaderDuration(), ns3::WifiPhy::CalculateTxDuration(), ns3::Create(), 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::WifiProtection::MU_RTS_CTS, 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 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 544 of file he-frame-exchange-manager.cc.

References ns3::WifiTxVector::GetModulationClass(), NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_FUNCTION, ns3::WifiTxVector::SetLength(), ns3::WifiDlMuAggregateTf::stationsReplyingWithBlockAck, and timeout.

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
psduMapthe map of PSDUs to send
txParamsthe TX parameters to use to transmit the PSDUs

Definition at line 191 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::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 )
protectedvirtual

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
triggerthe Basic or BSRP Trigger Frame content
hdrthe MAC header of the Basic or BSRP Trigger Frame

Reimplemented in ns3::EhtFrameExchangeManager.

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

References ns3::WifiTxParameters::AddMpdu(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMacHeader::GetDuration(), ns3::WifiTxParameters::GetSize(), ns3::CtrlTriggerHeader::GetUlLength(), ns3::CtrlTriggerHeader::IsBasic(), ns3::CtrlTriggerHeader::IsBsrp(), ns3::WifiTxParameters::m_acknowledgment, ns3::WifiTxParameters::m_protection, ns3::WifiTxParameters::m_txVector, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsTo(), ns3::WifiMacHeader::SetDuration(), ns3::WifiMacHeader::SetQosEosp(), ns3::WifiMacHeader::SetQosTid(), ns3::WifiMacHeader::SetSequenceNumber(), ns3::WifiTxParameters::UndoAddMpdu(), and ns3::WIFI_MAC_QOSDATA_NULL.

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

+ Here is the call graph for this function:
+ Here is the caller 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
muSchedulerthe Multi-user Scheduler associated with this Frame Exchange Manager

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

References ns3::FrameExchangeManager::m_apMac, ns3::FrameExchangeManager::m_mac, m_muScheduler, NS_ABORT_MSG_IF, and NS_ASSERT.

◆ 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
triggerthe given Trigger Frame

Definition at line 1600 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:

◆ 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
edcathe EDCAF which has been granted the opportunity to transmit
availableTimethe amount of time allowed for the frame exchange. Pass Time::Min() in case the TXOP limit is null
initialFrametrue 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 127 of file he-frame-exchange-manager.cc.

References ns3::Create(), ns3::MultiUserScheduler::DL_MU_TX, 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
txParamsthe TX parameters

Reimplemented from ns3::FrameExchangeManager.

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

References GetTfRecipients(), ns3::WifiTxParameters::m_protection, m_psduMap, ns3::FrameExchangeManager::m_sentRtsTo, ns3::WifiProtection::MU_RTS_CTS, NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_FUNCTION, 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
psduMapa pointer to PSDU map transmitted in a DL MU PPDU
nSolicitedStationsthe number of stations solicited to send a TB PPDU

Reimplemented in ns3::EhtFrameExchangeManager.

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

References NS_LOG_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 504 of file he-frame-exchange-manager.cc.

References ns3::WifiTxTimer::GetReason(), ns3::WifiPhy::GetSifs(), ns3::WifiTxTimer::GetStasExpectedToRespond(), ns3::Txop::GetTxopLimit(), ns3::WifiTxTimer::IsRunning(), ns3::Time::IsZero(), m_continueTxopAfterBsrpTf, ns3::QosFrameExchangeManager::m_edca, ns3::FrameExchangeManager::m_linkId, ns3::FrameExchangeManager::m_phy, ns3::FrameExchangeManager::m_protectedIfResponded, ns3::FrameExchangeManager::m_protectedStas, ns3::FrameExchangeManager::m_sentFrameTo, ns3::FrameExchangeManager::m_txNav, ns3::FrameExchangeManager::m_txTimer, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::WifiTxTimer::WAIT_QOS_NULL_AFTER_BSRP_TF.

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
triggerthe 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 2201 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
psduthe received PSDU
txVectorTxVector of the received PSDU

Reimplemented from ns3::FrameExchangeManager.

Definition at line 2066 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 2192 of file he-frame-exchange-manager.cc.

Member Data Documentation

◆ m_continueTxopAfterBsrpTf

bool ns3::HeFrameExchangeManager::m_continueTxopAfterBsrpTf
private

whether to continue a TXOP a SIFS after the reception of responses to a BSRP TF when TXOP limit is zero

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

Referenced by GetTypeId(), and TransmissionSucceeded().

◆ m_intraBssNavEnd

Time ns3::HeFrameExchangeManager::m_intraBssNavEnd
protected

intra-BSS NAV expiration time

Definition at line 363 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 364 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 397 of file he-frame-exchange-manager.h.

Referenced by DoDispose().

◆ m_muScheduler

Ptr<MultiUserScheduler> ns3::HeFrameExchangeManager::m_muScheduler
private

◆ m_muSnrTag

MuSnrTag ns3::HeFrameExchangeManager::m_muSnrTag
private

Tag to attach to Multi-STA BlockAck frames.

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

◆ m_psduMap

WifiPsduMap ns3::HeFrameExchangeManager::m_psduMap
private

◆ m_triggerFrame

Ptr<WifiMpdu> ns3::HeFrameExchangeManager::m_triggerFrame
private

Trigger Frame being sent.

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

◆ m_triggerFrameInAmpdu

bool ns3::HeFrameExchangeManager::m_triggerFrameInAmpdu
private

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

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

◆ m_trigVector

WifiTxVector ns3::HeFrameExchangeManager::m_trigVector
protected

the TRIGVECTOR

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

◆ m_txParams

WifiTxParameters ns3::HeFrameExchangeManager::m_txParams
private

the TX parameters for the current PPDU

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

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


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