Wi-Fi AP state machine. More...

#include "ap-wifi-mac.h"

Inheritance diagram for ns3::ApWifiMac:

Collaboration diagram for ns3::ApWifiMac:

Classes
struct	ApLinkEntity
	Structure holding information specific to a single link. More...

struct	BsrType
	store value and timestamp for each Buffer Status Report More...

Public Member Functions
	ApWifiMac ()

	~ApWifiMac () override

int64_t	AssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model.

bool	CanForwardPacketsTo (Mac48Address to) const override
	Return true if packets can be forwarded to the given destination, false otherwise.

void	ConfigureStandard (WifiStandard standard) override

void	Enqueue (Ptr< Packet > packet, Mac48Address to) override

void	Enqueue (Ptr< Packet > packet, Mac48Address to, Mac48Address from) override

uint16_t	GetAssociationId (Mac48Address addr, uint8_t linkId) const

Time	GetBeaconInterval () const

uint8_t	GetBufferStatus (uint8_t tid, Mac48Address address) const
	Return the value of the Queue Size subfield of the last QoS Data or QoS Null frame received from the station with the given MAC address and belonging to the given TID.

uint8_t	GetMaxBufferStatus (Mac48Address address) const
	Return the maximum among the values of the Queue Size subfield of the last QoS Data or QoS Null frames received from the station with the given MAC address and belonging to any TID.

std::optional< Mac48Address >	GetMldOrLinkAddressByAid (uint16_t aid) const

const std::map< uint16_t, Mac48Address > &	GetStaList (uint8_t linkId) const
	Get a const reference to the map of associated stations on the given link.

Ptr< WifiMacQueue >	GetTxopQueue (AcIndex ac) const override
	Get the wifi MAC queue of the (Qos)Txop associated with the given AC, if such (Qos)Txop is installed, or a null pointer, otherwise.

std::optional< uint8_t >	IsAssociated (const Mac48Address &address) const
	Get the ID of a link (if any) that has been setup with the station having the given MAC address.

void	SetBeaconInterval (Time interval)

void	SetBufferStatus (uint8_t tid, Mac48Address address, uint8_t size)
	Store the value of the Queue Size subfield of the last QoS Data or QoS Null frame received from the station with the given MAC address and belonging to the given TID.

void	SetLinkUpCallback (Callback< void > linkUp) override

bool	SupportsSendFrom () const override

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

	WifiMac (const WifiMac &)=delete

	~WifiMac () override

virtual int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model.

void	BlockUnicastTxOnLinks (WifiQueueBlockedReason reason, const Mac48Address &address, const std::set< uint8_t > &linkIds)
	Block the transmission on the given links of all unicast frames addressed to the station with the given address for the given reason.

virtual bool	CanForwardPacketsTo (Mac48Address to) const =0
	Return true if packets can be forwarded to the given destination, false otherwise.

virtual void	ConfigureStandard (WifiStandard standard)

virtual void	Enqueue (Ptr< Packet > packet, Mac48Address to)=0

virtual void	Enqueue (Ptr< Packet > packet, Mac48Address to, Mac48Address from)

Mac48Address	GetAddress () const

OriginatorAgreementOptConstRef	GetBaAgreementEstablishedAsOriginator (Mac48Address recipient, uint8_t tid) const

RecipientAgreementOptConstRef	GetBaAgreementEstablishedAsRecipient (Mac48Address originator, uint8_t tid) const

BlockAckReqType	GetBarTypeAsOriginator (const Mac48Address &recipient, uint8_t tid) const

BlockAckReqType	GetBarTypeAsRecipient (Mac48Address originator, uint8_t tid) const

BlockAckType	GetBaTypeAsOriginator (const Mac48Address &recipient, uint8_t tid) const

BlockAckType	GetBaTypeAsRecipient (Mac48Address originator, uint8_t tid) const

Mac48Address	GetBssid (uint8_t linkId) const

Ptr< ChannelAccessManager >	GetChannelAccessManager (uint8_t linkId=SINGLE_LINK_OP_ID) const
	Get the Channel Access Manager associated with the given link.

Ptr< WifiNetDevice >	GetDevice () const
	Return the device this PHY is associated with.

bool	GetDsssSupported (uint8_t linkId) const
	Return whether the device supports DSSS on the given link.

EhtCapabilities	GetEhtCapabilities (uint8_t linkId) const
	Return the EHT capabilities of the device for the given link.

Ptr< EhtConfiguration >	GetEhtConfiguration () const

bool	GetEhtSupported () const
	Return whether the device supports EHT.

bool	GetEhtSupported (const Mac48Address &address) const

bool	GetErpSupported (uint8_t linkId) const
	Return whether the device supports ERP on the given link.

ExtendedCapabilities	GetExtendedCapabilities () const
	Return the extended capabilities of the device.

Ptr< FrameExchangeManager >	GetFrameExchangeManager (uint8_t linkId=SINGLE_LINK_OP_ID) const
	Get the Frame Exchange Manager associated with the given link.

HeCapabilities	GetHeCapabilities (uint8_t linkId) const
	Return the HE capabilities of the device for the given link.

Ptr< HeConfiguration >	GetHeConfiguration () const

bool	GetHeSupported () const
	Return whether the device supports HE.

bool	GetHeSupported (const Mac48Address &address) const

HtCapabilities	GetHtCapabilities (uint8_t linkId) const
	Return the HT capabilities of the device for the given link.

Ptr< HtConfiguration >	GetHtConfiguration () const

bool	GetHtSupported () const
	Return whether the device supports HT.

bool	GetHtSupported (const Mac48Address &address) const

std::optional< uint8_t >	GetLinkForPhy (Ptr< const WifiPhy > phy) const
	Get the ID of the link (if any) on which the given PHY is operating.

std::optional< uint8_t >	GetLinkForPhy (std::size_t phyId) const
	Get the ID of the link (if any) on which the given PHY is operating.

virtual std::optional< uint8_t >	GetLinkIdByAddress (const Mac48Address &address) const
	Get the ID of the link having the given MAC address, if any.

const std::set< uint8_t > &	GetLinkIds () const

Mac48Address	GetLocalAddress (const Mac48Address &remoteAddr) const
	Get the local MAC address used to communicate with a remote STA.

Ptr< WifiMacQueueScheduler >	GetMacQueueScheduler () const
	Get the wifi MAC queue scheduler.

uint32_t	GetMaxAmpduSize (AcIndex ac) const
	Return the maximum A-MPDU size of the given Access Category.

uint16_t	GetMaxAmsduSize (AcIndex ac) const
	Return the maximum A-MSDU size of the given Access Category.

uint16_t	GetMaxBaBufferSize (std::optional< Mac48Address > address=std::nullopt) const
	Get the maximum Block Ack buffer size (in number of MPDUs) supported by the given device, if any, or by this device, otherwise, based on the supported standard.

std::optional< Mac48Address >	GetMldAddress (const Mac48Address &remoteAddr) const

uint16_t	GetMpduBufferSize () const

uint8_t	GetNLinks () const
	Get the number of links (can be greater than 1 for 11be devices only).

bool	GetQosSupported () const
	Return whether the device supports QoS.

Ptr< QosTxop >	GetQosTxop (AcIndex ac) const
	Accessor for a specified EDCA object.

Ptr< QosTxop >	GetQosTxop (uint8_t tid) const
	Accessor for a specified EDCA object.

Ssid	GetSsid () const

std::optional< std::reference_wrapper< const WifiTidLinkMapping > >	GetTidToLinkMapping (Mac48Address mldAddr, WifiDirection dir) const
	Get the TID-to-Link Mapping negotiated with the given MLD (if any) for the given direction.

Ptr< Txop >	GetTxop () const
	Accessor for the Txop object.

virtual Ptr< WifiMacQueue >	GetTxopQueue (AcIndex ac) const
	Get the wifi MAC queue of the (Qos)Txop associated with the given AC, if such (Qos)Txop is installed, or a null pointer, otherwise.

TypeOfStation	GetTypeOfStation () const
	Return the type of station.

VhtCapabilities	GetVhtCapabilities (uint8_t linkId) const
	Return the VHT capabilities of the device for the given link.

Ptr< VhtConfiguration >	GetVhtConfiguration () const

bool	GetVhtSupported (const Mac48Address &address) const

bool	GetVhtSupported (uint8_t linkId) const
	Return whether the device supports VHT on the given link.

Ptr< WifiPhy >	GetWifiPhy (uint8_t linkId=SINGLE_LINK_OP_ID) const

Ptr< WifiRemoteStationManager >	GetWifiRemoteStationManager (uint8_t linkId=0) const

virtual bool	HasFramesToTransmit (uint8_t linkId)
	Check if the MAC has frames to transmit over the given link.

virtual void	NotifyChannelSwitching (uint8_t linkId)
	Notify that channel on the given link has been switched.

void	NotifyPromiscRx (Ptr< const Packet > packet)

void	NotifyRx (Ptr< const Packet > packet)

void	NotifyRxDrop (Ptr< const Packet > packet)

void	NotifyTx (Ptr< const Packet > packet)

void	NotifyTxDrop (Ptr< const Packet > packet)

WifiMac &	operator= (const WifiMac &)=delete

void	ResetWifiPhys ()
	Remove currently attached WifiPhy objects from this MAC.

virtual void	SetAddress (Mac48Address address)

void	SetBssid (Mac48Address bssid, uint8_t linkId)

void	SetCtsToSelfSupported (bool enable)
	Enable or disable CTS-to-self feature.

void	SetDevice (const Ptr< WifiNetDevice > device)
	Sets the device this PHY is associated with.

void	SetForwardUpCallback (ForwardUpCallback upCallback)

void	SetLinkDownCallback (Callback< void > linkDown)

virtual void	SetLinkUpCallback (Callback< void > linkUp)

virtual void	SetMacQueueScheduler (Ptr< WifiMacQueueScheduler > scheduler)
	Set the wifi MAC queue scheduler.

void	SetMpduBufferSize (uint16_t size)

void	SetPromisc ()
	Sets the interface in promiscuous mode.

void	SetSsid (Ssid ssid)

void	SetTypeOfStation (TypeOfStation type)
	This method is invoked by a subclass to specify what type of station it is implementing.

virtual void	SetWifiPhys (const std::vector< Ptr< WifiPhy > > &phys)

void	SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)

void	SetWifiRemoteStationManagers (const std::vector< Ptr< WifiRemoteStationManager > > &stationManagers)

virtual bool	SupportsSendFrom () const

bool	TidMappedOnLink (Mac48Address mldAddr, WifiDirection dir, uint8_t tid, uint8_t linkId) const
	Check whether the given TID is mapped on the given link in the given direction for the given MLD.

void	UnblockUnicastTxOnLinks (WifiQueueBlockedReason reason, const Mac48Address &address, const std::set< uint8_t > &linkIds)
	Unblock the transmission on the given links of all unicast frames addressed to the station with the given address for the given reason.

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 TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::WifiMac
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
ApLinkEntity &	GetLink (uint8_t linkId) const
	Get a reference to the link associated with the given ID.

Protected Member Functions inherited from ns3::WifiMac
void	ApplyTidLinkMapping (const Mac48Address &mldAddr, WifiDirection dir)
	Apply the TID-to-Link Mapping negotiated with the given MLD for the given direction by properly configuring the queue scheduler.

virtual void	ConfigureContentionWindow (uint32_t cwMin, uint32_t cwMax)

virtual void	DeaggregateAmsduAndForward (Ptr< const WifiMpdu > mpdu)
	This method can be called to de-aggregate an A-MSDU and forward the constituent packets up the stack.

void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

void	ForwardUp (Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
	Forward the packet up to the device.

Ptr< QosTxop >	GetBEQueue () const
	Accessor for the AC_BE channel access function.

Ptr< QosTxop >	GetBKQueue () const
	Accessor for the AC_BK channel access function.

LinkEntity &	GetLink (uint8_t linkId) const
	Get a reference to the link associated with the given ID.

const std::map< uint8_t, std::unique_ptr< LinkEntity > > &	GetLinks () const

bool	GetShortSlotTimeSupported () const

Ptr< QosTxop >	GetVIQueue () const
	Accessor for the AC_VI channel access function.

Ptr< QosTxop >	GetVOQueue () const
	Accessor for the AC_VO channel access function.

virtual void	Receive (Ptr< const WifiMpdu > mpdu, uint8_t linkId)
	This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has been received on the given link.

void	SetQosSupported (bool enable)
	Enable or disable QoS support for the device.

void	SetShortSlotTimeSupported (bool enable)
	Enable or disable short slot time feature.

void	SwapLinks (std::map< uint8_t, uint8_t > links)
	Swap the links based on the information included in the given map.

void	UpdateTidToLinkMapping (const Mac48Address &mldAddr, WifiDirection dir, const WifiTidLinkMapping &mapping)
	Update the TID-to-Link Mappings for the given MLD in the given direction based on the given negotiated mappings.

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
std::map< uint16_t, Mac48Address >	m_aidToMldOrLinkAddress
	Maps AIDs to MLD addresses (for MLDs) or link addresses (in case of single link devices)

Protected Attributes inherited from ns3::WifiMac
Callback< void >	m_linkDown
	Callback when a link is down.

Callback< void >	m_linkUp
	Callback when a link is up.

Ptr< MacRxMiddle >	m_rxMiddle
	RX middle (defragmentation etc.)

Ptr< WifiMacQueueScheduler >	m_scheduler
	wifi MAC queue scheduler

Ptr< MacTxMiddle >	m_txMiddle
	TX middle (aggregation etc.)

Ptr< Txop >	m_txop
	TXOP used for transmission of frames to non-QoS peers.

Private Types
typedef void(*	AssociationCallback) (uint16_t aid, Mac48Address address)
	TracedCallback signature for association/deassociation events.

using	LinkIdStaAddrMap = std::map< uint8_t, Mac48Address >
	Map of (link ID, remote STA address) of the links to setup.

Private Member Functions
std::unique_ptr< LinkEntity >	CreateLinkEntity () const override
	Create a LinkEntity object.

void	DeaggregateAmsduAndForward (Ptr< const WifiMpdu > mpdu) override
	This method is called to de-aggregate an A-MSDU and forward the constituent packets up the stack.

void	DoDispose () override
	Destructor implementation.

Mac48Address	DoGetLocalAddress (const Mac48Address &remoteAddr) const override
	This method is called if this device is an MLD to determine the MAC address of the affiliated STA used to communicate with the single link device having the given MAC address.

void	DoInitialize () override
	Initialize() implementation.

void	ForwardDown (Ptr< Packet > packet, Mac48Address from, Mac48Address to)
	Forward the packet down to DCF/EDCAF (enqueue the packet).

void	ForwardDown (Ptr< Packet > packet, Mac48Address from, Mac48Address to, uint8_t tid)
	Forward the packet down to DCF/EDCAF (enqueue the packet).

MgtAssocResponseHeader	GetAssocResp (Mac48Address to, uint8_t linkId)
	Get the Association Response frame to send on a given link.

CapabilityInformation	GetCapabilities (uint8_t linkId) const
	Return the Capability information of the current AP for the given link.

DsssParameterSet	GetDsssParameterSet (uint8_t linkId) const
	Return the DSSS Parameter Set that we support on the given link.

EdcaParameterSet	GetEdcaParameterSet (uint8_t linkId) const
	Return the EDCA Parameter Set of the current AP for the given link.

EhtOperation	GetEhtOperation (uint8_t linkId) const
	Return the EHT operation of the current AP for the given link.

ErpInformation	GetErpInformation (uint8_t linkId) const
	Return the ERP information of the current AP for the given link.

HeOperation	GetHeOperation (uint8_t linkId) const
	Return the HE operation of the current AP for the given link.

HtOperation	GetHtOperation (uint8_t linkId) const
	Return the HT operation of the current AP for the given link.

LinkIdStaAddrMap	GetLinkIdStaAddrMap (MgtAssocResponseHeader &assoc, const Mac48Address &to, uint8_t linkId)
	Get a map of (link ID, remote STA address) of the links to setup.

std::optional< MuEdcaParameterSet >	GetMuEdcaParameterSet () const
	Return the MU EDCA Parameter Set of the current AP, if one needs to be advertised.

MultiLinkElement	GetMultiLinkElement (uint8_t linkId, WifiMacType frameType, const Mac48Address &to=Mac48Address::GetBroadcast())
	Return the Multi-Link Element that the current AP includes in the management frames of the given type it transmits on the given link.

uint16_t	GetNextAssociationId (std::list< uint8_t > linkIds)

std::optional< ReducedNeighborReport >	GetReducedNeighborReport (uint8_t linkId) const
	Return the Reduced Neighbor Report (RNR) element that the current AP sends on the given link, if one needs to be advertised.

AllSupportedRates	GetSupportedRates (uint8_t linkId) const
	Return an instance of SupportedRates that contains all rates that we support for the given link (including HT rates).

bool	GetUseNonErpProtection (uint8_t linkId) const
	Return whether protection for non-ERP stations is used in the BSS corresponding to the given link.

VhtOperation	GetVhtOperation (uint8_t linkId) const
	Return the VHT operation of the current AP for the given link.

void	ParseReportedStaInfo (const AssocReqRefVariant &assoc, Mac48Address from, uint8_t linkId)
	Given a (Re)Association Request frame body containing a Multi-Link Element, check if a link can be setup with each of the reported stations (STA MAC address and a (Re)Association Request frame body must be present, the Link ID identifies a valid link other than the one the frame was received on and the supported rates are compatible with our basic rate set).

void	ProcessPowerManagementFlag (Ptr< const WifiMpdu > mpdu, uint8_t linkId)
	Process the Power Management bit in the Frame Control field of an MPDU successfully received on the given link.

void	Receive (Ptr< const WifiMpdu > mpdu, uint8_t linkId) override
	This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has been received on the given link.

bool	ReceiveAssocRequest (const AssocReqRefVariant &assoc, const Mac48Address &from, uint8_t linkId)
	Check whether the supported rate set included in the received (Re)Association Request frame is compatible with our Basic Rate Set.

void	ReceiveEmlOmn (MgtEmlOmn &frame, const Mac48Address &sender, uint8_t linkId)
	Take necessary actions upon receiving the given EML Operating Mode Notification frame from the given station on the given link.

void	SendAssocResp (Mac48Address to, bool isReassoc, uint8_t linkId)
	Forward an association or a reassociation response packet to the DCF/EDCA.

void	SendOneBeacon (uint8_t linkId)
	Forward a beacon packet to the beacon special DCF for transmission on the given link.

void	SendProbeResp (Mac48Address to, uint8_t linkId)
	Send a Probe Response in response to a Probe Request received from the STA with the given address on the given link.

void	SetAid (MgtAssocResponseHeader &assoc, const LinkIdStaAddrMap &linkIdStaAddrMap)
	Set the AID field of the given Association Response frame.

void	SetBeaconGeneration (bool enable)
	Enable or disable beacon generation of the AP.

void	StaSwitchingToActiveModeOrDeassociated (const Mac48Address &staAddr, uint8_t linkId)
	Perform the necessary actions when a given station deassociates or switches from powersave mode to active mode.

void	StaSwitchingToPsMode (const Mac48Address &staAddr, uint8_t linkId)
	Perform the necessary actions when a given station switches from active mode to powersave mode.

void	TxFailed (WifiMacDropReason timeoutReason, Ptr< const WifiMpdu > mpdu)
	The packet we sent was successfully received by the receiver (i.e.

void	TxOk (Ptr< const WifiMpdu > mpdu)
	The packet we sent was successfully received by the receiver (i.e.

void	UpdateShortPreambleEnabled (uint8_t linkId)
	Update whether short preamble should be enabled or not in the BSS corresponding to the given link.

void	UpdateShortSlotTimeEnabled (uint8_t linkId)
	Update whether short slot time should be enabled or not in the BSS corresponding to the given link.

Private Attributes
TracedCallback< uint16_t, Mac48Address >	m_assocLogger
	association logger

Time	m_beaconInterval
	Beacon interval.

Ptr< UniformRandomVariable >	m_beaconJitter
	UniformRandomVariable used to randomize the time of the first beacon.

Ptr< Txop >	m_beaconTxop
	Dedicated Txop for beacons.

Time	m_bsrLifetime
	Lifetime of Buffer Status Reports.

std::unordered_map< WifiAddressTidPair, BsrType, WifiAddressTidHash >	m_bufferStatus
	Per (MAC address, TID) buffer status reports.

TracedCallback< uint16_t, Mac48Address >	m_deAssocLogger
	deassociation logger

bool	m_enableBeaconGeneration
	Flag whether beacons are being generated.

bool	m_enableBeaconJitter
	Flag whether the first beacon should be generated at random time.

bool	m_enableNonErpProtection
	Flag whether protection mechanism is used or not when non-ERP STAs are present within the BSS.

std::map< Mac48Address, EventId >	m_transitionTimeoutEvents
	transition timeout events running for EMLSR clients

Additional Inherited Members
Public Types inherited from ns3::WifiMac
typedef Callback< void, Ptr< const Packet >, Mac48Address, Mac48Address >	ForwardUpCallback
	This type defines the callback of a higher layer that a WifiMac(-derived) object invokes to pass a packet up the stack.

using	OriginatorAgreementOptConstRef = std::optional< std::reference_wrapper< const OriginatorBlockAckAgreement > >
	optional const reference to OriginatorBlockAckAgreement

using	RecipientAgreementOptConstRef = std::optional< std::reference_wrapper< const RecipientBlockAckAgreement > >
	optional const reference to RecipientBlockAckAgreement

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

Wi-Fi AP state machine.

Handle association, dis-association and authentication, of STAs within an infrastructure BSS.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/$ns3::ApWifiMac"

Attributes

BeaconGeneration: Whether or not beacons are generated.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwrite
BeaconInterval: Delay between two beacons
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +1.024e+08ns
- Flags: constructwriteread
BeaconJitter: A uniform random variable to cause the initial beacon starting time (after simulation time 0) to be distributed between 0 and the BeaconInterval.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::UniformRandomVariable>
- Initial value: ns3::UniformRandomVariable
- Flags: constructwriteread
BsrLifetime: Lifetime of Buffer Status Reports received from stations.
- Set with class: ns3::TimeValue
- Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
- Initial value: +2e+07ns
- Flags: constructwriteread
EnableBeaconJitter: If beacons are enabled, whether to jitter the initial send event.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
EnableNonErpProtection: Whether or not protection mechanism should be used when non-ERP STAs are present within the BSS.This parameter is only used when ERP is supported by the AP.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread

Attributes defined in parent class ns3::WifiMac

BE_BlockAckInactivityTimeout: Represents max time (blocks of 1024 microseconds) allowed for block ackinactivity for AC_BE. If this value isn't equal to 0 a timer start after that ablock ack setup is completed and will be reset every time that a block ackframe is received. If this value is 0, block ack inactivity timeout won't be used.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: constructwrite
BE_BlockAckThreshold: If number of packets in BE queue reaches this value, block ack mechanism is used. If this value is 0, block ack is never used.When A-MPDU is enabled, block ack mechanism is used regardless of this value.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:64
- Initial value: 0
- Flags: constructwrite
BE_MaxAmpduSize: Maximum length in bytes of an A-MPDU for AC_BE access class (capped to 65535 for HT PPDUs, 1048575 for VHT PPDUs, 6500631 for HE PPDUs and 15523200 for EHT PPDUs). Value 0 means A-MPDU aggregation is disabled for that AC.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:15523200
- Initial value: 65535
- Flags: constructwriteread
BE_MaxAmsduSize: Maximum length in bytes of an A-MSDU for AC_BE access class (capped to 7935 for HT PPDUs and 11398 for VHT/HE/EHT PPDUs). Value 0 means A-MSDU aggregation is disabled for that AC.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:11398
- Initial value: 0
- Flags: constructwriteread
BE_Txop: Queue that manages packets belonging to AC_BE access class.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::QosTxop>
- Flags: read
BK_BlockAckInactivityTimeout: Represents max time (blocks of 1024 microseconds) allowed for block ackinactivity for AC_BK. If this value isn't equal to 0 a timer start after that ablock ack setup is completed and will be reset every time that a block ackframe is received. If this value is 0, block ack inactivity timeout won't be used.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: constructwrite
BK_BlockAckThreshold: If number of packets in BK queue reaches this value, block ack mechanism is used. If this value is 0, block ack is never used.When A-MPDU is enabled, block ack mechanism is used regardless of this value.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:64
- Initial value: 0
- Flags: constructwrite
BK_MaxAmpduSize: Maximum length in bytes of an A-MPDU for AC_BK access class (capped to 65535 for HT PPDUs, 1048575 for VHT PPDUs, 6500631 for HE PPDUs and 15523200 for EHT PPDUs). Value 0 means A-MPDU aggregation is disabled for that AC.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:15523200
- Initial value: 0
- Flags: constructwriteread
BK_MaxAmsduSize: Maximum length in bytes of an A-MSDU for AC_BK access class (capped to 7935 for HT PPDUs and 11398 for VHT/HE/EHT PPDUs). Value 0 means A-MSDU aggregation is disabled for that AC.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:11398
- Initial value: 0
- Flags: constructwriteread
BK_Txop: Queue that manages packets belonging to AC_BK access class.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::QosTxop>
- Flags: read
CtsToSelfSupported: Use CTS to Self when using a rate that is not in the basic rate set.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: constructwrite
MpduBufferSize: The size (in number of MPDUs) of the buffer used for each BlockAck agreement in which this node is a recipient. The provided value is capped to the maximum allowed value based on the supported standard.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 1:1024
- Initial value: 1024
- Flags: constructwriteread
QosSupported: This Boolean attribute is set to enable 802.11e/WMM-style QoS support at this STA.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: constructread
ShortSlotTimeSupported: Whether or not short slot time is supported (only used by ERP APs or STAs).
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
Ssid: The ssid we want to belong to.
- Set with class: ns3::SsidValue
- Underlying type: Ssid
- Initial value: ssid=default
- Flags: constructwriteread
Txop: The Txop object.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::Txop>
- Flags: read
VI_BlockAckInactivityTimeout: Represents max time (blocks of 1024 microseconds) allowed for block ackinactivity for AC_VI. If this value isn't equal to 0 a timer start after that ablock ack setup is completed and will be reset every time that a block ackframe is received. If this value is 0, block ack inactivity timeout won't be used.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: constructwrite
VI_BlockAckThreshold: If number of packets in VI queue reaches this value, block ack mechanism is used. If this value is 0, block ack is never used.When A-MPDU is enabled, block ack mechanism is used regardless of this value.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:64
- Initial value: 0
- Flags: constructwrite
VI_MaxAmpduSize: Maximum length in bytes of an A-MPDU for AC_VI access class (capped to 65535 for HT PPDUs, 1048575 for VHT PPDUs, 6500631 for HE PPDUs and 15523200 for EHT PPDUs). Value 0 means A-MPDU aggregation is disabled for that AC.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:15523200
- Initial value: 65535
- Flags: constructwriteread
VI_MaxAmsduSize: Maximum length in bytes of an A-MSDU for AC_VI access class (capped to 7935 for HT PPDUs and 11398 for VHT/HE/EHT PPDUs). Value 0 means A-MSDU aggregation is disabled for that AC.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:11398
- Initial value: 0
- Flags: constructwriteread
VI_Txop: Queue that manages packets belonging to AC_VI access class.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::QosTxop>
- Flags: read
VO_BlockAckInactivityTimeout: Represents max time (blocks of 1024 microseconds) allowed for block ackinactivity for AC_VO. If this value isn't equal to 0 a timer start after that ablock ack setup is completed and will be reset every time that a block ackframe is received. If this value is 0, block ack inactivity timeout won't be used.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: constructwrite
VO_BlockAckThreshold: If number of packets in VO queue reaches this value, block ack mechanism is used. If this value is 0, block ack is never used.When A-MPDU is enabled, block ack mechanism is used regardless of this value.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:64
- Initial value: 0
- Flags: constructwrite
VO_MaxAmpduSize: Maximum length in bytes of an A-MPDU for AC_VO access class (capped to 65535 for HT PPDUs, 1048575 for VHT PPDUs, 6500631 for HE PPDUs and 15523200 for EHT PPDUs). Value 0 means A-MPDU aggregation is disabled for that AC.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:15523200
- Initial value: 0
- Flags: constructwriteread
VO_MaxAmsduSize: Maximum length in bytes of an A-MSDU for AC_VO access class (capped to 7935 for HT PPDUs and 11398 for VHT/HE/EHT PPDUs). Value 0 means A-MSDU aggregation is disabled for that AC.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:11398
- Initial value: 0
- Flags: constructwriteread
VO_Txop: Queue that manages packets belonging to AC_VO access class.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::QosTxop>
- Flags: read

TraceSources

AssociatedSta: A station associated with this access point.
Callback signature: ns3::ApWifiMac::AssociationCallback
DeAssociatedSta: A station lost association with this access point.
Callback signature: ns3::ApWifiMac::AssociationCallback

TraceSources defined in parent class ns3::WifiMac

AckedMpdu: An MPDU that was successfully acknowledged, via either a Normal Ack or a Block Ack.
Callback signature: ns3::WifiMpdu::TracedCallback
DroppedMpdu: An MPDU that was dropped for the given reason (see WifiMacDropReason).
Callback signature: ns3::WifiMac::DroppedMpduCallback
MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace.
Callback signature: ns3::Packet::TracedCallback
MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace.
Callback signature: ns3::Packet::TracedCallback
MacRxDrop: A packet has been dropped in the MAC layer after it has been passed up from the physical layer.
Callback signature: ns3::Packet::TracedCallback
MacTx: A packet has been received from higher layers and is being processed in preparation for queueing for transmission.
Callback signature: ns3::Packet::TracedCallback
MacTxDrop: A packet has been dropped in the MAC layer before being queued for transmission. This trace source is fired, e.g., when an AP's MAC receives from the upper layer a packet destined to a station that is not associated with the AP or a STA's MAC receives a packet from the upper layer while it is not associated with any AP.
Callback signature: ns3::Packet::TracedCallback
MpduResponseTimeout: An MPDU whose response was not received before the timeout, along with an identifier of the type of timeout (see WifiTxTimer::Reason) and the TXVECTOR used to transmit the MPDU. This trace source is fired when a CTS is missing after an RTS, when all CTS frames are missing after an MU-RTS, or when a Normal Ack is missing after an MPDU or after a DL MU PPDU acknowledged in SU format.
Callback signature: ns3::WifiMac::MpduResponseTimeoutCallback
NAckedMpdu: An MPDU that was negatively acknowledged via a Block Ack.
Callback signature: ns3::WifiMpdu::TracedCallback
PsduMapResponseTimeout: A PSDU map for which not all the responses were received before the timeout, along with an identifier of the type of timeout (see WifiTxTimer::Reason), the set of MAC addresses of the stations that did not respond and the total number of stations that had to respond. This trace source is fired when not all the addressed stations responded to an MU-BAR Trigger frame (either sent as a SU frame or aggregated to PSDUs in the DL MU PPDU), a Basic Trigger Frame or a BSRP Trigger Frame.
Callback signature: ns3::WifiMac::PsduMapResponseTimeoutCallback
PsduResponseTimeout: A PSDU whose response was not received before the timeout, along with an identifier of the type of timeout (see WifiTxTimer::Reason) and the TXVECTOR used to transmit the PSDU. This trace source is fired when a BlockAck is missing after an A-MPDU, a BlockAckReq (possibly in the context of the acknowledgment of a DL MU PPDU in SU format) or a TB PPDU (in the latter case the missing BlockAck is a Multi-STA BlockAck).
Callback signature: ns3::WifiMac::PsduResponseTimeoutCallback

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

Definition at line 64 of file ap-wifi-mac.h.

Member Typedef Documentation

◆ AssociationCallback

typedef void(* ns3::ApWifiMac::AssociationCallback) (uint16_t aid, Mac48Address address)

private

TracedCallback signature for association/deassociation events.

Parameters

aid	the AID of the station
address	the MAC address of the station

Definition at line 537 of file ap-wifi-mac.h.

◆ LinkIdStaAddrMap

using ns3::ApWifiMac::LinkIdStaAddrMap = std::map<uint8_t, Mac48Address>

private

Map of (link ID, remote STA address) of the links to setup.

Definition at line 306 of file ap-wifi-mac.h.

Constructor & Destructor Documentation

◆ ApWifiMac()

ns3::ApWifiMac::ApWifiMac ( )

Definition at line 111 of file ap-wifi-mac.cc.

References ns3::AC_BEACON, ns3::AP, m_beaconTxop, ns3::WifiMac::m_txMiddle, NS_LOG_FUNCTION, ns3::Txop::SetTxMiddle(), and ns3::WifiMac::SetTypeOfStation().

Here is the call graph for this function:

◆ ~ApWifiMac()

ns3::ApWifiMac::~ApWifiMac ( )

override

Definition at line 122 of file ap-wifi-mac.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::ApWifiMac::AssignStreams ( int64_t stream )

overridevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Reimplemented from ns3::WifiMac.

Definition at line 236 of file ap-wifi-mac.cc.

References ns3::WifiMac::AssignStreams(), m_beaconJitter, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

◆ CanForwardPacketsTo()

bool ns3::ApWifiMac::CanForwardPacketsTo ( Mac48Address to ) const

overridevirtual

Return true if packets can be forwarded to the given destination, false otherwise.

Parameters

to	the address to which the packet should be sent

Returns: whether packets can be forwarded to the given destination

Implements ns3::WifiMac.

Definition at line 394 of file ap-wifi-mac.cc.

References IsAssociated(), and ns3::Mac48Address::IsGroup().

Referenced by Enqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConfigureStandard()

void ns3::ApWifiMac::ConfigureStandard ( WifiStandard standard )

overridevirtual

Parameters

standard the wifi standard to be configured

This method completes the configuration process for a requested PHY standard by creating the Frame Exchange Manager and the Channel Access Manager and configuring the PHY dependent parameters. This method can only be called after a configured PHY has been set.

Reimplemented from ns3::WifiMac.

Definition at line 156 of file ap-wifi-mac.cc.

References ns3::ChannelAccessManager::Add(), ns3::WifiMac::LinkEntity::channelAccessManager, ns3::WifiMac::ConfigureStandard(), GetLink(), ns3::WifiMac::GetNLinks(), m_beaconTxop, NS_LOG_FUNCTION, ns3::Txop::SetAifsns(), ns3::Txop::SetMaxCws(), ns3::Txop::SetMinCws(), and ns3::Txop::SetWifiMac().

Here is the call graph for this function:

◆ CreateLinkEntity()

std::unique_ptr< WifiMac::LinkEntity > ns3::ApWifiMac::CreateLinkEntity ( ) const

overrideprivatevirtual

Create a LinkEntity object.

Returns: a unique pointer to the created LinkEntity object

Reimplemented from ns3::WifiMac.

Definition at line 144 of file ap-wifi-mac.cc.

◆ DeaggregateAmsduAndForward()

void ns3::ApWifiMac::DeaggregateAmsduAndForward ( Ptr< const WifiMpdu > mpdu )

overrideprivatevirtual

This method is called to de-aggregate an A-MSDU and forward the constituent packets up the stack.

We override the WifiMac version here because, as an AP, we also need to think about redistributing to other associated STAs.

Parameters

mpdu	the MPDU containing the A-MSDU.

Reimplemented from ns3::WifiMac.

Definition at line 2316 of file ap-wifi-mac.cc.

References ForwardDown(), ns3::WifiMac::ForwardUp(), IsAssociated(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::PeekPointer().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::ApWifiMac::DoDispose ( )

overrideprivatevirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 128 of file ap-wifi-mac.cc.

References ns3::Object::Dispose(), ns3::WifiMac::DoDispose(), m_beaconTxop, m_enableBeaconGeneration, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoGetLocalAddress()

Mac48Address ns3::ApWifiMac::DoGetLocalAddress ( const Mac48Address & remoteAddr ) const

overrideprivatevirtual

This method is called if this device is an MLD to determine the MAC address of the affiliated STA used to communicate with the single link device having the given MAC address.

This method is overridden because its implementation depends on the type of station.

Parameters

remoteAddr the MAC address of the remote single link device

Returns: the MAC address of the affiliated STA used to communicate with the remote device

Reimplemented from ns3::WifiMac.

Definition at line 1645 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetFrameExchangeManager(), IsAssociated(), and NS_ASSERT_MSG.

Here is the call graph for this function:

◆ DoInitialize()

void ns3::ApWifiMac::DoInitialize ( )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 2335 of file ap-wifi-mac.cc.

References ns3::ApWifiMac::ApLinkEntity::beaconEvent, ns3::EventId::Cancel(), ns3::WifiMac::DoInitialize(), ns3::WifiMac::GetAddress(), GetBeaconInterval(), GetLink(), ns3::Time::GetMicroSeconds(), ns3::WifiMac::GetNLinks(), ns3::UniformRandomVariable::GetValue(), ns3::Object::Initialize(), m_beaconJitter, m_beaconTxop, m_enableBeaconGeneration, m_enableBeaconJitter, ns3::MakeCallback(), ns3::MicroSeconds(), NS_ABORT_IF, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), SendOneBeacon(), ns3::ObjectBase::TraceConnectWithoutContext(), TxFailed(), TxOk(), UpdateShortPreambleEnabled(), and UpdateShortSlotTimeEnabled().

Here is the call graph for this function:

◆ Enqueue() [1/2]

void ns3::ApWifiMac::Enqueue	(	Ptr< Packet >	packet,
		Mac48Address	to
	)

overridevirtual

Parameters

packet	the packet to send.
to	the address to which the packet should be sent.

The packet should be enqueued in a TX queue, and should be dequeued as soon as the DCF function determines that access it granted to this MAC.

Implements ns3::WifiMac.

Definition at line 414 of file ap-wifi-mac.cc.

References Enqueue(), ns3::WifiMac::GetAddress(), and NS_LOG_FUNCTION.

Referenced by Enqueue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Enqueue() [2/2]

void ns3::ApWifiMac::Enqueue	(	Ptr< Packet >	packet,
		Mac48Address	to,
		Mac48Address	from
	)

overridevirtual

Parameters

packet	the packet to send.
to	the address to which the packet should be sent.
from	the address from which the packet should be sent.

The packet should be enqueued in a TX queue, and should be dequeued as soon as the DCF function determines that access it granted to this MAC. The extra parameter "from" allows this device to operate in a bridged mode, forwarding received frames without altering the source address.

Reimplemented from ns3::WifiMac.

Definition at line 400 of file ap-wifi-mac.cc.

References CanForwardPacketsTo(), ForwardDown(), ns3::WifiMac::NotifyTxDrop(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ ForwardDown() [1/2]

void ns3::ApWifiMac::ForwardDown	(	Ptr< Packet >	packet,
		Mac48Address	from,
		Mac48Address	to
	)

private

Forward the packet down to DCF/EDCAF (enqueue the packet).

This method is a wrapper for ForwardDown with traffic id.

Parameters

packet	the packet we are forwarding to DCF/EDCAF
from	the address to be used for Address 3 field in the header
to	the address to be used for Address 1 field in the header

Definition at line 293 of file ap-wifi-mac.cc.

References ForwardDown(), ns3::WifiMac::GetQosSupported(), NS_LOG_FUNCTION, and ns3::QosUtilsGetTidForPacket().

Referenced by DeaggregateAmsduAndForward(), Enqueue(), ForwardDown(), and Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ForwardDown() [2/2]

void ns3::ApWifiMac::ForwardDown	(	Ptr< Packet >	packet,
		Mac48Address	from,
		Mac48Address	to,
		uint8_t	tid
	)

private

Forward the packet down to DCF/EDCAF (enqueue the packet).

Parameters

packet	the packet we are forwarding to DCF/EDCAF
from	the address to be used for Address 3 field in the header
to	the address to be used for Address 1 field in the header
tid	the traffic id for the packet

Definition at line 318 of file ap-wifi-mac.cc.

Here is the call graph for this function:

◆ GetAssociationId()

uint16_t ns3::ApWifiMac::GetAssociationId	(	Mac48Address	addr,
		uint8_t	linkId
	)		const

Parameters

addr	the address of the associated station
linkId	the ID of the link on which the station is associated

Returns: the Association ID allocated by the AP to the station, SU_STA_ID if unallocated

Definition at line 2400 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetWifiRemoteStationManager().

Referenced by MultiLinkSetupTest::CheckMlSetup(), and ns3::HeFrameExchangeManager::SendPsduMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAssocResp()

MgtAssocResponseHeader ns3::ApWifiMac::GetAssocResp	(	Mac48Address	to,
		uint8_t	linkId
	)

private

Get the Association Response frame to send on a given link.

The returned frame never includes a Multi-Link Element.

Parameters

to	the address of the STA we are sending an association response to
linkId	the ID of the given link

Returns: the Association Response frame

Definition at line 1079 of file ap-wifi-mac.cc.

References ns3::MgtAssocResponseHeader::Capabilities(), GetCapabilities(), GetEdcaParameterSet(), ns3::WifiMac::GetEhtCapabilities(), GetEhtOperation(), ns3::WifiMac::GetEhtSupported(), ns3::WifiMac::GetExtendedCapabilities(), ns3::WifiMac::GetHeCapabilities(), GetHeOperation(), ns3::WifiMac::GetHeSupported(), ns3::WifiMac::GetHtCapabilities(), GetHtOperation(), ns3::WifiMac::GetHtSupported(), GetMuEdcaParameterSet(), ns3::WifiMac::GetQosSupported(), GetSupportedRates(), ns3::WifiMac::GetVhtCapabilities(), GetVhtOperation(), ns3::WifiMac::GetVhtSupported(), ns3::WifiMac::GetWifiRemoteStationManager(), NS_ABORT_IF, ns3::StatusCode::SetFailure(), ns3::MgtAssocResponseHeader::SetStatusCode(), and ns3::StatusCode::SetSuccess().

Referenced by GetMultiLinkElement(), and SendAssocResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBeaconInterval()

Time ns3::ApWifiMac::GetBeaconInterval ( ) const

Returns: the interval between two beacon transmissions.

Definition at line 200 of file ap-wifi-mac.cc.

References m_beaconInterval, and NS_LOG_FUNCTION.

Referenced by DoInitialize(), GetTypeId(), SendOneBeacon(), and SendProbeResp().

Here is the caller graph for this function:

◆ GetBufferStatus()

uint8_t ns3::ApWifiMac::GetBufferStatus	(	uint8_t	tid,
		Mac48Address	address
	)		const

Return the value of the Queue Size subfield of the last QoS Data or QoS Null frame received from the station with the given MAC address and belonging to the given TID.

The Queue Size value is the total size, rounded up to the nearest multiple of 256 octets and expressed in units of 256 octets, of all MSDUs and A-MSDUs buffered at the STA (excluding the MSDU or A-MSDU of the present QoS Data frame). A queue size value of 254 is used for all sizes greater than 64 768 octets. A queue size value of 255 is used to indicate an unspecified or unknown size. See Section 9.2.4.5.6 of 802.11-2016

Parameters

tid	the given TID
address	the given MAC address

Returns: the value of the Queue Size subfield

Definition at line 2406 of file ap-wifi-mac.cc.

References m_bsrLifetime, m_bufferStatus, and ns3::Simulator::Now().

Referenced by GetMaxBufferStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCapabilities()

CapabilityInformation ns3::ApWifiMac::GetCapabilities ( uint8_t linkId ) const

private

Return the Capability information of the current AP for the given link.

Parameters

linkId the ID of the given link

Returns: the Capability information that we support

Definition at line 486 of file ap-wifi-mac.cc.

References GetLink(), NS_LOG_FUNCTION, ns3::CapabilityInformation::SetEss(), ns3::CapabilityInformation::SetShortPreamble(), and ns3::CapabilityInformation::SetShortSlotTime().

Referenced by GetAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDsssParameterSet()

DsssParameterSet ns3::ApWifiMac::GetDsssParameterSet ( uint8_t linkId ) const

private

Return the DSSS Parameter Set that we support on the given link.

Parameters

linkId the ID of the given link

Returns: the DSSS Parameter Set that we support on the given link

Definition at line 476 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetDsssSupported(), ns3::WifiMac::GetWifiPhy(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::DsssParameterSet::SetCurrentChannel().

Referenced by SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetEdcaParameterSet()

EdcaParameterSet ns3::ApWifiMac::GetEdcaParameterSet ( uint8_t linkId ) const

private

Return the EDCA Parameter Set of the current AP for the given link.

Parameters

linkId the ID of the given link

Returns: the EDCA Parameter Set that we support for the given link

Definition at line 518 of file ap-wifi-mac.cc.

Referenced by GetAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetEhtOperation()

EhtOperation ns3::ApWifiMac::GetEhtOperation ( uint8_t linkId ) const

private

Return the EHT operation of the current AP for the given link.

Parameters

linkId the ID of the given link

Returns: the EHT operation that we support

Definition at line 947 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetEhtSupported(), GetLink(), ns3::WifiPhy::GetMaxSupportedRxSpatialStreams(), ns3::WifiMac::GetWifiPhy(), ns3::WifiMac::GetWifiRemoteStationManager(), NS_ASSERT, NS_LOG_FUNCTION, ns3::EhtOperation::SetMaxRxNss(), ns3::EhtOperation::SetMaxTxNss(), and ns3::WIFI_EHT_MAX_MCS_INDEX.

Referenced by GetAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetErpInformation()

ErpInformation ns3::ApWifiMac::GetErpInformation ( uint8_t linkId ) const

private

Return the ERP information of the current AP for the given link.

Parameters

linkId the ID of the given link

Returns: the ERP information that we support for the given link

Definition at line 497 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetErpSupported(), GetLink(), GetUseNonErpProtection(), NS_ASSERT, NS_LOG_FUNCTION, ns3::ErpInformation::SetBarkerPreambleMode(), ns3::ErpInformation::SetNonErpPresent(), and ns3::ErpInformation::SetUseProtection().

Referenced by SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHeOperation()

HeOperation ns3::ApWifiMac::GetHeOperation ( uint8_t linkId ) const

private

Return the HE operation of the current AP for the given link.

Parameters

linkId the ID of the given link

Returns: the HE operation that we support

Definition at line 917 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetHeConfiguration(), ns3::WifiMac::GetHeSupported(), GetLink(), ns3::WifiPhy::GetMaxSupportedRxSpatialStreams(), ns3::WifiMac::GetWifiPhy(), ns3::WifiMac::GetWifiRemoteStationManager(), NS_ASSERT, NS_LOG_FUNCTION, ns3::HeOperation::SetBssColor(), and ns3::HeOperation::SetMaxHeMcsPerNss().

Referenced by GetAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetHtOperation()

HtOperation ns3::ApWifiMac::GetHtOperation ( uint8_t linkId ) const

private

Return the HT operation of the current AP for the given link.

Parameters

linkId the ID of the given link

Returns: the HT operation that we support

Definition at line 770 of file ap-wifi-mac.cc.

Referenced by GetAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLink()

ApWifiMac::ApLinkEntity & ns3::ApWifiMac::GetLink ( uint8_t linkId ) const

protected

Get a reference to the link associated with the given ID.

Parameters

linkId the given link ID

Returns: a reference to the link associated with the given ID

Definition at line 150 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetLink().

Referenced by ConfigureStandard(), DoInitialize(), GetCapabilities(), GetEhtOperation(), GetErpInformation(), GetHeOperation(), GetHtOperation(), GetReducedNeighborReport(), GetStaList(), GetUseNonErpProtection(), GetVhtOperation(), Receive(), ReceiveEmlOmn(), SendOneBeacon(), SendProbeResp(), SetAid(), SetBeaconGeneration(), UpdateShortPreambleEnabled(), and UpdateShortSlotTimeEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLinkIdStaAddrMap()

ApWifiMac::LinkIdStaAddrMap ns3::ApWifiMac::GetLinkIdStaAddrMap	(	MgtAssocResponseHeader &	assoc,
		const Mac48Address &	to,
		uint8_t	linkId
	)

private

Get a map of (link ID, remote STA address) of the links to setup.

Information is taken from the given Association Response that is sent over the given link to the given station.

Parameters

assoc	the given Association Response frame
to	the Receiver Address (RA) of the Association Response frame
linkId	the ID of the link on which the Association Response frame is sent

Returns: a map of (link ID, remote STA address) of the links to setup

Definition at line 1137 of file ap-wifi-mac.cc.

References ns3::MgtAssocResponseHeader::GetStatusCode(), ns3::WifiMac::GetWifiRemoteStationManager(), ns3::StatusCode::IsSuccess(), and NS_ABORT_MSG_IF.

Referenced by SendAssocResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMaxBufferStatus()

uint8_t ns3::ApWifiMac::GetMaxBufferStatus ( Mac48Address address ) const

Return the maximum among the values of the Queue Size subfield of the last QoS Data or QoS Null frames received from the station with the given MAC address and belonging to any TID.

Parameters

address the given MAC address

Returns: the maximum among the values of the Queue Size subfields

Definition at line 2431 of file ap-wifi-mac.cc.

References GetBufferStatus().

Referenced by ns3::RrMultiUserScheduler::TrySendingBasicTf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMldOrLinkAddressByAid()

std::optional< Mac48Address > ns3::ApWifiMac::GetMldOrLinkAddressByAid ( uint16_t aid ) const

Parameters

aid	the given AID

Returns: the MLD address (in case of MLD) or link address (in case of single link device) of the STA having the given AID, if any

Definition at line 1653 of file ap-wifi-mac.cc.

References m_aidToMldOrLinkAddress.

Referenced by EmlsrDlTxopTest::CheckInitialControlFrame(), ns3::MultiUserScheduler::GetMaxSizeOfQosNullAmpdu(), ns3::RrMultiUserScheduler::NotifyStationAssociated(), ns3::RrMultiUserScheduler::NotifyStationDeassociated(), and ns3::RrMultiUserScheduler::TrySendingBasicTf().

Here is the caller graph for this function:

◆ GetMuEdcaParameterSet()

std::optional< MuEdcaParameterSet > ns3::ApWifiMac::GetMuEdcaParameterSet ( ) const

private

Return the MU EDCA Parameter Set of the current AP, if one needs to be advertised.

Returns: the MU EDCA Parameter Set that needs to be advertised (if any)

Definition at line 565 of file ap-wifi-mac.cc.

References ns3::AC_BE, ns3::AC_BK, ns3::AC_VI, ns3::AC_VO, ns3::TimeValue::Get(), ns3::UintegerValue::Get(), ns3::WifiMac::GetHeConfiguration(), ns3::WifiMac::GetHeSupported(), ns3::MuEdcaParameterSet::GetMuEdcaTimer(), ns3::Time::IsZero(), NS_ABORT_MSG_UNLESS, NS_ASSERT, NS_LOG_FUNCTION, ns3::MuEdcaParameterSet::SetMuAifsn(), ns3::MuEdcaParameterSet::SetMuCwMax(), ns3::MuEdcaParameterSet::SetMuCwMin(), ns3::MuEdcaParameterSet::SetMuEdcaTimer(), and ns3::MuEdcaParameterSet::SetQosInfo().

Referenced by GetAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMultiLinkElement()

MultiLinkElement ns3::ApWifiMac::GetMultiLinkElement	(	uint8_t	linkId,
		WifiMacType	frameType,
		const Mac48Address &	to = `Mac48Address::GetBroadcast()`
	)

private

Return the Multi-Link Element that the current AP includes in the management frames of the given type it transmits on the given link.

Parameters

linkId	the ID of the link to send the Multi-Link Element onto
frameType	the type of the frame containing the Multi-Link Element
to	the Receiver Address of the frame containing the Multi-Link Element

Returns: the Multi-Link Element

Definition at line 664 of file ap-wifi-mac.cc.

Referenced by SendAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNextAssociationId()

uint16_t ns3::ApWifiMac::GetNextAssociationId ( std::list< uint8_t > linkIds )

private

Parameters

linkIds the IDs of the links for which the next Association ID is requested

Returns: the next Association ID to be allocated by the AP on the given links

Definition at line 2376 of file ap-wifi-mac.cc.

References NS_FATAL_ERROR.

Referenced by SetAid().

Here is the caller graph for this function:

◆ GetReducedNeighborReport()

std::optional< ReducedNeighborReport > ns3::ApWifiMac::GetReducedNeighborReport ( uint8_t linkId ) const

private

Return the Reduced Neighbor Report (RNR) element that the current AP sends on the given link, if one needs to be advertised.

Parameters

linkId the ID of the link to send the RNR element onto

Returns: the Reduced Neighbor Report element

Definition at line 633 of file ap-wifi-mac.cc.

Referenced by SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetStaList()

const std::map< uint16_t, Mac48Address > & ns3::ApWifiMac::GetStaList ( uint8_t linkId ) const

Get a const reference to the map of associated stations on the given link.

Each station is specified by an (association ID, MAC address) pair. Make sure not to use the returned reference after that this object has been deallocated.

Parameters

linkId the ID of the given link

Returns: a const reference to the map of associated stations

Definition at line 2394 of file ap-wifi-mac.cc.

References GetLink(), and ns3::ApWifiMac::ApLinkEntity::staList.

Referenced by MultiLinkSetupTest::CheckMlSetup(), TestMultiUserScheduler::ComputeWifiTxVector(), ns3::MultiUserScheduler::GetTriggerFrame(), ns3::HeFrameExchangeManager::RecordSentMuRtsTo(), TestMultiUserScheduler::SelectTxFormat(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), and ns3::RrMultiUserScheduler::TrySendingBsrpTf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSupportedRates()

AllSupportedRates ns3::ApWifiMac::GetSupportedRates ( uint8_t linkId ) const

private

Return an instance of SupportedRates that contains all rates that we support for the given link (including HT rates).

Parameters

linkId the ID of the given link

Returns: all rates that we support

Definition at line 431 of file ap-wifi-mac.cc.

References ns3::AllSupportedRates::AddBssMembershipSelectorRate(), ns3::AllSupportedRates::AddSupportedRate(), ns3::WifiMode::GetDataRate(), ns3::WifiMac::GetHtSupported(), ns3::WifiMode::GetUniqueName(), ns3::WifiMac::GetWifiPhy(), ns3::WifiMac::GetWifiRemoteStationManager(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::AllSupportedRates::SetBasicRate(), and ns3::WIFI_MOD_CLASS_HR_DSSS.

Referenced by GetAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTxopQueue()

Ptr< WifiMacQueue > ns3::ApWifiMac::GetTxopQueue ( AcIndex ac ) const

overridevirtual

Get the wifi MAC queue of the (Qos)Txop associated with the given AC, if such (Qos)Txop is installed, or a null pointer, otherwise.

Parameters

ac	the given Access Category

Returns: the wifi MAC queue of the (Qos)Txop associated with the given AC, if such (Qos)Txop is installed, or a null pointer, otherwise

Reimplemented from ns3::WifiMac.

Definition at line 171 of file ap-wifi-mac.cc.

References ns3::AC_BEACON, ns3::WifiMac::GetTxopQueue(), ns3::Txop::GetWifiMacQueue(), and m_beaconTxop.

Referenced by MultiLinkMuTxTest::CheckBlockAck().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ApWifiMac::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 58 of file ap-wifi-mac.cc.

References GetBeaconInterval(), m_assocLogger, m_beaconJitter, m_bsrLifetime, m_deAssocLogger, m_enableBeaconJitter, m_enableNonErpProtection, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakePointerAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MicroSeconds(), ns3::MilliSeconds(), SetBeaconGeneration(), SetBeaconInterval(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetUseNonErpProtection()

bool ns3::ApWifiMac::GetUseNonErpProtection ( uint8_t linkId ) const

private

Return whether protection for non-ERP stations is used in the BSS corresponding to the given link.

Parameters

linkId the ID of the given link

Returns: true if protection for non-ERP stations is used in the BSS, false otherwise

Definition at line 2368 of file ap-wifi-mac.cc.

References GetLink(), ns3::WifiMac::GetWifiRemoteStationManager(), m_enableNonErpProtection, and ns3::ApWifiMac::ApLinkEntity::numNonErpStations.

Referenced by GetErpInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetVhtOperation()

VhtOperation ns3::ApWifiMac::GetVhtOperation ( uint8_t linkId ) const

private

Return the VHT operation of the current AP for the given link.

Parameters

linkId the ID of the given link

Returns: the VHT operation that we support

Definition at line 868 of file ap-wifi-mac.cc.

References GetLink(), ns3::WifiMac::GetVhtSupported(), ns3::WifiMac::GetWifiPhy(), ns3::WifiMac::GetWifiRemoteStationManager(), NS_ASSERT, NS_LOG_FUNCTION, ns3::VhtOperation::SetChannelCenterFrequencySegment0(), ns3::VhtOperation::SetChannelCenterFrequencySegment1(), ns3::VhtOperation::SetChannelWidth(), and ns3::VhtOperation::SetMaxVhtMcsPerNss().

Referenced by GetAssocResp(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsAssociated()

std::optional< uint8_t > ns3::ApWifiMac::IsAssociated ( const Mac48Address & address ) const

Get the ID of a link (if any) that has been setup with the station having the given MAC address.

The address can be either a link address or an MLD address. In the former case, the returned ID is the ID of the link connecting the AP to the STA with the given address.

Parameters

address the given MAC address

Returns: the ID of a link (if any) that has been setup with the given station

Definition at line 1631 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetNLinks(), ns3::WifiMac::GetWifiRemoteStationManager(), and NS_LOG_DEBUG.

Referenced by CanForwardPacketsTo(), DeaggregateAmsduAndForward(), DoGetLocalAddress(), ForwardDown(), ns3::MultiUserScheduler::GetDlMuInfo(), ns3::RrMultiUserScheduler::NotifyStationDeassociated(), Receive(), and StaSwitchingToActiveModeOrDeassociated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ParseReportedStaInfo()

void ns3::ApWifiMac::ParseReportedStaInfo	(	const AssocReqRefVariant &	assoc,
		Mac48Address	from,
		uint8_t	linkId
	)

private

Given a (Re)Association Request frame body containing a Multi-Link Element, check if a link can be setup with each of the reported stations (STA MAC address and a (Re)Association Request frame body must be present, the Link ID identifies a valid link other than the one the frame was received on and the supported rates are compatible with our basic rate set).

Parameters

assoc	the frame body of the received (Re)Association Request
from	the Transmitter Address field of the frame
linkId	the ID of the link on which the frame was received

Definition at line 2128 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetNLinks(), ns3::WifiMac::GetWifiRemoteStationManager(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ReceiveAssocRequest().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessPowerManagementFlag()

void ns3::ApWifiMac::ProcessPowerManagementFlag	(	Ptr< const WifiMpdu >	mpdu,
		uint8_t	linkId
	)

private

Process the Power Management bit in the Frame Control field of an MPDU successfully received on the given link.

Parameters

mpdu	the successfully received MPDU
linkId	the ID of the given link

Definition at line 1581 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetWifiRemoteStationManager(), NS_LOG_FUNCTION, StaSwitchingToActiveModeOrDeassociated(), and StaSwitchingToPsMode().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Receive()

void ns3::ApWifiMac::Receive	(	Ptr< const WifiMpdu >	mpdu,
		uint8_t	linkId
	)

overrideprivatevirtual

This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has been received on the given link.

The implementation is intended to capture logic that is going to be common to all (or most) derived classes. Specifically, handling of Block Ack management frames is dealt with here.

This method will need, however, to be overridden by derived classes so that they can perform their data handling before invoking the base version.

The given link may be undefined in some cases (e.g., in case of QoS Data frames received in the context of a Block Ack agreement – because the BlockAckManager does not have to record the link each buffered MPDU has been received on); in such a cases, the value of linkId should be WIFI_LINKID_UNDEFINED.

Parameters

mpdu	the MPDU that has been received.
linkId	the ID of the given link

Reimplemented from ns3::WifiMac.

Definition at line 1664 of file ap-wifi-mac.cc.

Here is the call graph for this function:

◆ ReceiveAssocRequest()

bool ns3::ApWifiMac::ReceiveAssocRequest	(	const AssocReqRefVariant &	assoc,
		const Mac48Address &	from,
		uint8_t	linkId
	)

private

Check whether the supported rate set included in the received (Re)Association Request frame is compatible with our Basic Rate Set.

If so, record all the station's supported modes in its associated WifiRemoteStation and return true. Otherwise, return false.

Parameters

assoc	the frame body of the received (Re)Association Request
from	the Transmitter Address field of the frame
linkId	the ID of the link on which the frame was received

Returns: true if the (Re)Association request can be accepted, false otherwise

Definition at line 1862 of file ap-wifi-mac.cc.

Referenced by ParseReportedStaInfo(), and Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ReceiveEmlOmn()

void ns3::ApWifiMac::ReceiveEmlOmn	(	MgtEmlOmn &	frame,
		const Mac48Address &	sender,
		uint8_t	linkId
	)

private

Take necessary actions upon receiving the given EML Operating Mode Notification frame from the given station on the given link.

Parameters

frame	the received EML Operating Mode Notification frame
sender	the MAC address of the sender of the frame
linkId	the ID of the link over which the frame was received

After the successful transmission of the EML Operating Mode Notification frame by the non-AP STA affiliated with the non-AP MLD, the non-AP MLD shall operate in the EMLSR mode and the other non-AP STAs operating on the corresponding EMLSR links shall transition to active mode after the transition delay indicated in the Transition Timeout subfield in the EML Capabilities subfield of the Basic Multi-Link element or immediately after receiving an EML Operating Mode Notification frame from one of the APs operating on the EMLSR links and affiliated with the AP MLD (Sec. 35.3.17 of 802.11be D3.0)

After the successful transmission of the EML Operating Mode Notification frame by the non-AP STA affiliated with the non-AP MLD, the non-AP MLD shall disable the EMLSR mode and the other non-AP STAs operating on the corresponding EMLSR links shall transition to power save mode after the transition delay indicated in the Transition Timeout subfield in the EML Capabilities subfield of the Basic Multi-Link element or immediately after receiving an EML Operating Mode Notification frame from one of the APs operating on the EMLSR links and affiliated with the AP MLD. (Sec. 35.3.17 of 802.11be D3.0)

Definition at line 2178 of file ap-wifi-mac.cc.

References ns3::WifiPhy::CalculateTxDuration(), ns3::MgtEmlOmn::EmlControl::emlsrMode, ns3::MgtEmlOmn::EmlControl::emlsrParamUpdateCtrl, ns3::BooleanValue::Get(), ns3::TimeValue::Get(), ns3::WifiMac::GetEhtConfiguration(), GetLink(), ns3::MgtEmlOmn::GetLinkBitmap(), ns3::WifiMac::GetWifiRemoteStationManager(), ns3::MgtEmlOmn::m_emlControl, ns3::MgtEmlOmn::m_emlsrParamUpdate, m_transitionTimeoutEvents, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendAssocResp()

void ns3::ApWifiMac::SendAssocResp	(	Mac48Address	to,
		bool	isReassoc,
		uint8_t	linkId
	)

private

Forward an association or a reassociation response packet to the DCF/EDCA.

Parameters

to	the address of the STA we are sending an association response to
isReassoc	indicates whether it is a reassociation response
linkId	the ID of the link on which the association response must be sent

Definition at line 1310 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetAddress(), GetAssocResp(), ns3::WifiMac::GetBEQueue(), ns3::WifiMac::GetFrameExchangeManager(), GetLinkIdStaAddrMap(), ns3::WifiMac::GetMldAddress(), GetMultiLinkElement(), ns3::WifiMac::GetNLinks(), ns3::WifiMac::GetQosSupported(), ns3::WifiMac::GetTxop(), ns3::WifiMacHeader::GetType(), ns3::WifiMac::GetVOQueue(), ns3::WifiMac::GetWifiRemoteStationManager(), NS_LOG_FUNCTION, ns3::Txop::Queue(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), SetAid(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetType(), ns3::WIFI_MAC_MGT_ASSOCIATION_RESPONSE, and ns3::WIFI_MAC_MGT_REASSOCIATION_RESPONSE.

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendOneBeacon()

void ns3::ApWifiMac::SendOneBeacon ( uint8_t linkId )

private

Forward a beacon packet to the beacon special DCF for transmission on the given link.

Parameters

linkId the ID of the given link

Definition at line 1363 of file ap-wifi-mac.cc.

Referenced by DoInitialize(), SendOneBeacon(), and SetBeaconGeneration().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendProbeResp()

void ns3::ApWifiMac::SendProbeResp	(	Mac48Address	to,
		uint8_t	linkId
	)

private

Send a Probe Response in response to a Probe Request received from the STA with the given address on the given link.

Parameters

to	the address of the STA we are sending a probe response to
linkId	the ID of the given link

Definition at line 971 of file ap-wifi-mac.cc.

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetAid()

void ns3::ApWifiMac::SetAid	(	MgtAssocResponseHeader &	assoc,
		const LinkIdStaAddrMap &	linkIdStaAddrMap
	)

private

Set the AID field of the given Association Response frame.

In case of multi-link setup, the selected AID value must be assigned to all the STAs corresponding to the setup links. The AID value is selected among the AID values that are possibly already assigned to the STAs affiliated with the non-AP MLD we are associating with. If no STA has an assigned AID value, a new AID value is selected.

Parameters

assoc	the given Association Response frame
linkIdStaAddrMap	a map of (link ID, remote STA address) of the links to setup

Definition at line 1177 of file ap-wifi-mac.cc.

References GetLink(), GetNextAssociationId(), ns3::MgtAssocResponseHeader::GetStatusCode(), ns3::WifiMac::GetWifiRemoteStationManager(), ns3::StatusCode::IsSuccess(), m_aidToMldOrLinkAddress, m_assocLogger, ns3::MgtAssocResponseHeader::SetAssociationId(), UpdateShortPreambleEnabled(), and UpdateShortSlotTimeEnabled().

Referenced by SendAssocResp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBeaconGeneration()

void ns3::ApWifiMac::SetBeaconGeneration ( bool enable )

private

Enable or disable beacon generation of the AP.

Parameters

enable enable or disable beacon generation

Definition at line 181 of file ap-wifi-mac.cc.

References ns3::ApWifiMac::ApLinkEntity::beaconEvent, ns3::EventId::Cancel(), GetLink(), ns3::WifiMac::GetNLinks(), m_enableBeaconGeneration, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and SendOneBeacon().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBeaconInterval()

void ns3::ApWifiMac::SetBeaconInterval ( Time interval )

Parameters

interval the interval between two beacon transmissions.

Definition at line 219 of file ap-wifi-mac.cc.

References ns3::Time::GetMicroSeconds(), m_beaconInterval, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by WifiPrimaryChannelsTest::DoRun(), and GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBufferStatus()

void ns3::ApWifiMac::SetBufferStatus	(	uint8_t	tid,
		Mac48Address	address,
		uint8_t	size
	)

Store the value of the Queue Size subfield of the last QoS Data or QoS Null frame received from the station with the given MAC address and belonging to the given TID.

Parameters

tid	the given TID
address	the given MAC address
size	the value of the Queue Size subfield

Definition at line 2417 of file ap-wifi-mac.cc.

References m_bufferStatus, and ns3::Simulator::Now().

Here is the call graph for this function:

◆ SetLinkUpCallback()

void ns3::ApWifiMac::SetLinkUpCallback ( Callback< void > linkUp )

overridevirtual

Parameters

linkUp the callback to invoke when the link becomes up.

Reimplemented from ns3::WifiMac.

Definition at line 207 of file ap-wifi-mac.cc.

References NS_LOG_FUNCTION, and ns3::WifiMac::SetLinkUpCallback().

Here is the call graph for this function:

◆ StaSwitchingToActiveModeOrDeassociated()

void ns3::ApWifiMac::StaSwitchingToActiveModeOrDeassociated	(	const Mac48Address &	staAddr,
		uint8_t	linkId
	)

private

Perform the necessary actions when a given station deassociates or switches from powersave mode to active mode.

Parameters

staAddr	the MAC address of the given station
linkId	the ID of the link on which the given station is operating

Definition at line 1614 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetWifiRemoteStationManager(), IsAssociated(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::POWER_SAVE_MODE, and ns3::WifiMac::UnblockUnicastTxOnLinks().

Referenced by ProcessPowerManagementFlag(), and Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StaSwitchingToPsMode()

void ns3::ApWifiMac::StaSwitchingToPsMode	(	const Mac48Address &	staAddr,
		uint8_t	linkId
	)

private

Perform the necessary actions when a given station switches from active mode to powersave mode.

Parameters

staAddr	the MAC address of the given station
linkId	the ID of the link on which the given station is operating

Definition at line 1601 of file ap-wifi-mac.cc.

References ns3::WifiMac::BlockUnicastTxOnLinks(), ns3::WifiMac::GetWifiRemoteStationManager(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::POWER_SAVE_MODE.

Referenced by ProcessPowerManagementFlag(), and TxOk().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SupportsSendFrom()

bool ns3::ApWifiMac::SupportsSendFrom ( ) const

overridevirtual

Returns: if this MAC supports sending from arbitrary address.

The interface may or may not support sending from arbitrary address. This function returns true if sending from arbitrary address is supported, false otherwise.

Reimplemented from ns3::WifiMac.

Definition at line 424 of file ap-wifi-mac.cc.

References NS_LOG_FUNCTION.

◆ TxFailed()

void ns3::ApWifiMac::TxFailed	(	WifiMacDropReason	timeoutReason,
		Ptr< const WifiMpdu >	mpdu
	)

private

The packet we sent was successfully received by the receiver (i.e.

we did not receive an Ack from the receiver). If the packet was an association response to the receiver, we record that the receiver is not associated with us yet.

Parameters

timeoutReason the reason why the TX timer was started (

See also: WifiTxTimer::Reason)

Parameters

mpdu	the MPDU that we failed to sent

Definition at line 1542 of file ap-wifi-mac.cc.

References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMac::GetAddress(), ns3::WifiMac::GetFrameExchangeManager(), ns3::WifiMac::GetLinkIdByAddress(), ns3::WifiMac::GetNLinks(), ns3::WifiMac::GetWifiRemoteStationManager(), ns3::WifiMacHeader::IsAssocResp(), ns3::WifiMacHeader::IsReassocResp(), NS_ABORT_MSG_IF, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TxOk()

void ns3::ApWifiMac::TxOk ( Ptr< const WifiMpdu > mpdu )

private

The packet we sent was successfully received by the receiver (i.e.

we received an Ack from the receiver). If the packet was an association response to the receiver, we record that the receiver is now associated with us.

Parameters

mpdu	the MPDU that we successfully sent

The STA is affiliated with an MLD. From Sec. 35.3.7.1.4 of 802.11be D3.0: When a link becomes enabled for a non-AP STA that is affiliated with a non-AP MLD after successful association with an AP MLD with (Re)Association Request/Response frames transmitted on another link [...], the power management mode of the non-AP STA, immediately after the acknowledgement of the (Re)Association Response frame [...], is power save mode, and its power state is doze.

Thus, STAs operating on all the links but the link used to establish association transition to power save mode.

Definition at line 1471 of file ap-wifi-mac.cc.

References ns3::WifiMac::ApplyTidLinkMapping(), ns3::DOWNLINK, ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr2(), ns3::WifiMac::GetAddress(), ns3::WifiMac::GetFrameExchangeManager(), ns3::WifiMac::GetLinkIdByAddress(), ns3::WifiMac::GetNLinks(), ns3::WifiMac::GetWifiRemoteStationManager(), ns3::WifiMacHeader::IsAction(), ns3::WifiMacHeader::IsAssocResp(), ns3::WifiMacHeader::IsReassocResp(), m_transitionTimeoutEvents, NS_ABORT_MSG_IF, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiActionHeader::Peek(), ns3::WifiActionHeader::PROTECTED_EHT, ns3::WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION, and StaSwitchingToPsMode().

Referenced by DoInitialize().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateShortPreambleEnabled()

void ns3::ApWifiMac::UpdateShortPreambleEnabled ( uint8_t linkId )

private

Update whether short preamble should be enabled or not in the BSS corresponding to the given link.

Typically, short preamble is enabled only when the AP and all associated stations support short PHY preamble. Otherwise, it is disabled.

Parameters

linkId the ID of the given link

Definition at line 269 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetErpSupported(), GetLink(), ns3::WifiMac::GetWifiPhy(), ns3::WifiMac::GetWifiRemoteStationManager(), and NS_LOG_FUNCTION.

Referenced by DoInitialize(), Receive(), and SetAid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateShortSlotTimeEnabled()

void ns3::ApWifiMac::UpdateShortSlotTimeEnabled ( uint8_t linkId )

private

Update whether short slot time should be enabled or not in the BSS corresponding to the given link.

Typically, short slot time is enabled only when there is no non-ERP station associated to the AP, and that short slot time is supported by the AP and by all other ERP stations that are associated to the AP. Otherwise, it is disabled.

Parameters

linkId the ID of the given link

Definition at line 246 of file ap-wifi-mac.cc.

References ns3::WifiMac::GetErpSupported(), GetLink(), ns3::WifiMac::GetShortSlotTimeSupported(), ns3::WifiMac::GetWifiRemoteStationManager(), and NS_LOG_FUNCTION.

Referenced by DoInitialize(), Receive(), and SetAid().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_aidToMldOrLinkAddress

std::map<uint16_t, Mac48Address> ns3::ApWifiMac::m_aidToMldOrLinkAddress

protected

Maps AIDs to MLD addresses (for MLDs) or link addresses (in case of single link devices)

Definition at line 195 of file ap-wifi-mac.h.

Referenced by GetMldOrLinkAddressByAid(), and SetAid().

◆ m_assocLogger

TracedCallback<uint16_t , Mac48Address> ns3::ApWifiMac::m_assocLogger

private

association logger

Definition at line 539 of file ap-wifi-mac.h.

Referenced by GetTypeId(), and SetAid().

◆ m_beaconInterval

Time ns3::ApWifiMac::m_beaconInterval

private

Beacon interval.

Definition at line 511 of file ap-wifi-mac.h.

Referenced by GetBeaconInterval(), and SetBeaconInterval().

◆ m_beaconJitter

Ptr<UniformRandomVariable> ns3::ApWifiMac::m_beaconJitter

private

UniformRandomVariable used to randomize the time of the first beacon.

Definition at line 513 of file ap-wifi-mac.h.

Referenced by AssignStreams(), DoInitialize(), and GetTypeId().

◆ m_beaconTxop

Ptr<Txop> ns3::ApWifiMac::m_beaconTxop

private

Dedicated Txop for beacons.

Definition at line 509 of file ap-wifi-mac.h.

Referenced by ApWifiMac(), ConfigureStandard(), DoDispose(), DoInitialize(), GetTxopQueue(), and SendOneBeacon().

◆ m_bsrLifetime

Time ns3::ApWifiMac::m_bsrLifetime

private

Lifetime of Buffer Status Reports.

Definition at line 517 of file ap-wifi-mac.h.

Referenced by GetBufferStatus(), and GetTypeId().

◆ m_bufferStatus

std::unordered_map<WifiAddressTidPair, BsrType, WifiAddressTidHash> ns3::ApWifiMac::m_bufferStatus

private

Per (MAC address, TID) buffer status reports.

Definition at line 529 of file ap-wifi-mac.h.

Referenced by GetBufferStatus(), and SetBufferStatus().

◆ m_deAssocLogger

TracedCallback<uint16_t , Mac48Address> ns3::ApWifiMac::m_deAssocLogger

private

deassociation logger

Definition at line 540 of file ap-wifi-mac.h.

Referenced by GetTypeId(), and Receive().

◆ m_enableBeaconGeneration

bool ns3::ApWifiMac::m_enableBeaconGeneration

private

Flag whether beacons are being generated.

Definition at line 510 of file ap-wifi-mac.h.

Referenced by DoDispose(), DoInitialize(), and SetBeaconGeneration().

◆ m_enableBeaconJitter

bool ns3::ApWifiMac::m_enableBeaconJitter

private

Flag whether the first beacon should be generated at random time.

Definition at line 514 of file ap-wifi-mac.h.

Referenced by DoInitialize(), and GetTypeId().

◆ m_enableNonErpProtection

bool ns3::ApWifiMac::m_enableNonErpProtection

private

Flag whether protection mechanism is used or not when non-ERP STAs are present within the BSS.

Definition at line 515 of file ap-wifi-mac.h.

Referenced by GetTypeId(), and GetUseNonErpProtection().

◆ m_transitionTimeoutEvents

std::map<Mac48Address, EventId> ns3::ApWifiMac::m_transitionTimeoutEvents

private

transition timeout events running for EMLSR clients

Definition at line 519 of file ap-wifi-mac.h.

Referenced by ReceiveEmlOmn(), and TxOk().

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

src/wifi/model/ap-wifi-mac.h
src/wifi/model/ap-wifi-mac.cc

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::WifiMac

TraceSources

TraceSources defined in parent class ns3::WifiMac

Member Typedef Documentation

◆ AssociationCallback

◆ LinkIdStaAddrMap

Constructor & Destructor Documentation

◆ ApWifiMac()

◆ ~ApWifiMac()

Member Function Documentation

◆ AssignStreams()

◆ CanForwardPacketsTo()

◆ ConfigureStandard()

◆ CreateLinkEntity()

◆ DeaggregateAmsduAndForward()

◆ DoDispose()

◆ DoGetLocalAddress()

◆ DoInitialize()

◆ Enqueue() [1/2]

◆ Enqueue() [2/2]

◆ ForwardDown() [1/2]

◆ ForwardDown() [2/2]

◆ GetAssociationId()

◆ GetAssocResp()

◆ GetBeaconInterval()

◆ GetBufferStatus()

◆ GetCapabilities()

◆ GetDsssParameterSet()

◆ GetEdcaParameterSet()

◆ GetEhtOperation()

◆ GetErpInformation()

◆ GetHeOperation()

◆ GetHtOperation()

◆ GetLink()

◆ GetLinkIdStaAddrMap()

◆ GetMaxBufferStatus()

◆ GetMldOrLinkAddressByAid()

◆ GetMuEdcaParameterSet()

◆ GetMultiLinkElement()

◆ GetNextAssociationId()

◆ GetReducedNeighborReport()

◆ GetStaList()

◆ GetSupportedRates()

◆ GetTxopQueue()

◆ GetTypeId()

◆ GetUseNonErpProtection()

◆ GetVhtOperation()

◆ IsAssociated()

◆ ParseReportedStaInfo()

◆ ProcessPowerManagementFlag()

◆ Receive()

◆ ReceiveAssocRequest()

◆ ReceiveEmlOmn()

◆ SendAssocResp()

◆ SendOneBeacon()

◆ SendProbeResp()

◆ SetAid()

◆ SetBeaconGeneration()

◆ SetBeaconInterval()

◆ SetBufferStatus()

◆ SetLinkUpCallback()

◆ StaSwitchingToActiveModeOrDeassociated()

◆ StaSwitchingToPsMode()

◆ SupportsSendFrom()

◆ TxFailed()

◆ TxOk()

◆ UpdateShortPreambleEnabled()

◆ UpdateShortSlotTimeEnabled()