Wi-Fi AP state machineHandle association, dis-association and authentication, of STAs within an infrastructure BSS. More...

#include "ap-wifi-mac.h"

Inheritance diagram for ns3::ApWifiMac:

Collaboration diagram for ns3::ApWifiMac:

Public Member Functions
	ApWifiMac ()

virtual	~ApWifiMac ()

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

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

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

Time	GetBeaconInterval (void) const

bool	GetShortPreambleEnabled (void) const
	Determine whether short preamble should be enabled or not in the BSS. More...

bool	GetShortSlotTimeEnabled (void) const
	Determine whether short slot time should be enabled or not in the BSS. More...

virtual void	SetAddress (Mac48Address address)

void	SetBeaconInterval (Time interval)

virtual void	SetLinkUpCallback (Callback< void > linkUp)

virtual void	SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)

void	StartBeaconing (void)
	Start beacon transmission immediately. More...

virtual bool	SupportsSendFrom (void) const

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

virtual	~RegularWifiMac ()

Time	GetAckTimeout (void) const

virtual Mac48Address	GetAddress (void) const

virtual Time	GetBasicBlockAckTimeout (void) const

virtual Mac48Address	GetBssid (void) const

virtual Time	GetCompressedBlockAckTimeout (void) const

Time	GetCtsTimeout (void) const

bool	GetCtsToSelfSupported () const
	Return whether the device supports CTS-to-self capability. More...

Time	GetEifsNoDifs (void) const

HtCapabilities	GetHtCapabilities (void) const
	Return the HT capability of the device. More...

Time	GetPifs (void) const

Time	GetRifs (void) const

virtual bool	GetShortSlotTimeSupported (void) const

Time	GetSifs (void) const

Time	GetSlot (void) const

virtual Ssid	GetSsid (void) const

VhtCapabilities	GetVhtCapabilities (void) const
	Return the VHT capability of the device. More...

virtual Ptr< WifiPhy >	GetWifiPhy (void) const

virtual Ptr< WifiRemoteStationManager >	GetWifiRemoteStationManager (void) const

virtual void	ResetWifiPhy (void)
	removes attached WifiPhy device from this MAC. More...

void	SetAckTimeout (Time ackTimeout)

virtual void	SetBasicBlockAckTimeout (Time blockAckTimeout)

virtual void	SetBssid (Mac48Address bssid)

virtual void	SetCompressedBlockAckTimeout (Time blockAckTimeout)

void	SetCtsTimeout (Time ctsTimeout)

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

void	SetEifsNoDifs (Time eifsNoDifs)

virtual void	SetForwardUpCallback (ForwardUpCallback upCallback)

virtual void	SetLinkDownCallback (Callback< void > linkDown)

void	SetPifs (Time pifs)

virtual void	SetPromisc (void)
	Sets the interface in promiscuous mode. More...

void	SetRifs (Time rifs)

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

void	SetSifs (Time sifs)

void	SetSlot (Time slotTime)

virtual void	SetSsid (Ssid ssid)

virtual void	SetWifiPhy (Ptr< WifiPhy > phy)

Public Member Functions inherited from ns3::WifiMac
void	ConfigureStandard (enum WifiPhyStandard standard)

Time	GetMaxPropagationDelay (void) const

Time	GetMsduLifetime (void) const

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)

virtual void	SetForwardUpCallback (Callback< void, Ptr< Packet >, Mac48Address, Mac48Address > upCallback)=0

void	SetMaxPropagationDelay (Time delay)

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

virtual	~Object ()
	Destructor. More...

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

void	Dispose (void)
	Dispose of this Object. More...

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

virtual TypeId	GetInstanceTypeId (void) const
	Implement the GetInstanceTypeId method defined in ObjectBase. More...

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

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

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

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

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

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::RegularWifiMac
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::WifiMac
static TypeId	GetTypeId (void)

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

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

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

Private Member Functions
virtual void	DeaggregateAmsduAndForward (Ptr< Packet > aggregatedPacket, const WifiMacHeader *hdr)
	This method is called to de-aggregate an A-MSDU and forward the constituent packets up the stack. More...

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

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

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

bool	GetBeaconGeneration (void) const
	Return whether the AP is generating beacons. More...

CapabilityInformation	GetCapabilities (void) const
	Return the Capability information of the current AP. More...

ErpInformation	GetErpInformation (void) const
	Return the ERP information of the current AP. More...

HtOperations	GetHtOperations (void) const
	Return the HT operations of the current AP. More...

SupportedRates	GetSupportedRates (void) const
	Return an instance of SupportedRates that contains all rates that we support including HT rates. More...

bool	GetUseNonErpProtection (void) const
	Return whether protection for non-ERP stations is used in the BSS. More...

virtual void	Receive (Ptr< Packet > packet, const WifiMacHeader *hdr)
	This method acts as the MacRxMiddle receive callback and is invoked to notify us that a frame has been received. More...

void	SendAssocResp (Mac48Address to, bool success)
	Forward an association response packet to the DCF. More...

void	SendOneBeacon (void)
	Forward a beacon packet to the beacon special DCF. More...

void	SendProbeResp (Mac48Address to)
	Forward a probe response packet to the DCF. More...

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

virtual void	TxFailed (const WifiMacHeader &hdr)
	The packet we sent was successfully received by the receiver (i.e. More...

virtual void	TxOk (const WifiMacHeader &hdr)
	The packet we sent was successfully received by the receiver (i.e. More...

Private Attributes
Ptr< DcaTxop >	m_beaconDca
	Dedicated DcaTxop for beacons. More...

EventId	m_beaconEvent
	Event to generate one beacon. More...

Time	m_beaconInterval
	Interval between beacons. More...

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

bool	m_enableBeaconGeneration
	Flag whether beacons are being generated. More...

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

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

std::list< Mac48Address >	m_nonErpStations
	List of all non-ERP stations currently associated to the AP. More...

std::list< Mac48Address >	m_nonHtStations
	List of all non-HT stations currently associated to the AP. More...

std::list< Mac48Address >	m_staList
	List of all stations currently associated to the AP. More...

Additional Inherited Members
Public Types inherited from ns3::RegularWifiMac
typedef Callback< void, Ptr< 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. More...

Protected Types inherited from ns3::RegularWifiMac
typedef std::map< AcIndex, Ptr< EdcaTxopN > >	EdcaQueues
	This type defines a mapping between an Access Category index, and a pointer to the corresponding channel access function. More...

Protected Member Functions inherited from ns3::RegularWifiMac
void	ConfigureContentionWindow (uint32_t cwMin, uint32_t cwMax)

virtual void	FinishConfigureStandard (enum WifiPhyStandard standard)

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

Ptr< EdcaTxopN >	GetBEQueue (void) const
	Accessor for the AC_BE channel access function. More...

Ptr< EdcaTxopN >	GetBKQueue (void) const
	Accessor for the AC_BK channel access function. More...

Ptr< DcaTxop >	GetDcaTxop (void) const
	Accessor for the DCF object. More...

bool	GetErpSupported () const
	Return whether the device supports ERP. More...

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

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

bool	GetVhtSupported () const
	Return whether the device supports VHT. More...

Ptr< EdcaTxopN >	GetVIQueue (void) const
	Accessor for the AC_VI channel access function. More...

Ptr< EdcaTxopN >	GetVOQueue (void) const
	Accessor for the AC_VO channel access function. More...

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

void	SetErpSupported (bool enable)
	Enable or disable ERP support for the device. More...

void	SetHtSupported (bool enable)
	Enable or disable HT support for the device. More...

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

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

void	SetVhtSupported (bool enable)
	Enable or disable VHT support for the device. More...

Protected Member Functions inherited from ns3::WifiMac
void	ConfigureDcf (Ptr< Dcf > dcf, uint32_t cwmin, uint32_t cwmax, enum AcIndex ac)

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

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

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

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

Protected Attributes inherited from ns3::RegularWifiMac
Ptr< DcaTxop >	m_dca
	This holds a pointer to the DCF instance for this WifiMac - used for transmission of frames to non-QoS peers. More...

DcfManager *	m_dcfManager
	DCF manager (access to channel) More...

EdcaQueues	m_edca
	This is a map from Access Category index to the corresponding channel access function. More...

bool	m_erpSupported
	This Boolean is set `true` iff this WifiMac is to model 802.11g. More...

ForwardUpCallback	m_forwardUp
	Callback to forward packet up the stack. More...

bool	m_htSupported
	This Boolean is set `true` iff this WifiMac is to model 802.11n. More...

Callback< void >	m_linkDown
	Callback when a link is down. More...

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

Ptr< MacLow >	m_low
	MacLow (RTS, CTS, DATA, ACK etc.) More...

Ptr< WifiPhy >	m_phy
	Wifi PHY. More...

bool	m_qosSupported
	This Boolean is set `true` iff this WifiMac is to model 802.11e/WMM style Quality of Service. More...

MacRxMiddle *	m_rxMiddle
	RX middle (de-fragmentation etc.) More...

Ssid	m_ssid
	Service Set ID (SSID) More...

Ptr< WifiRemoteStationManager >	m_stationManager
	Remote station manager (rate control, RTS/CTS/fragmentation thresholds etc.) More...

MacTxMiddle *	m_txMiddle
	TX middle (aggregation etc.) More...

bool	m_vhtSupported
	This Boolean is set `true` iff this WifiMac is to model 802.11ac. More...

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

Detailed Description

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::RegularWifiMac/$ns3::ApWifiMac"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/$ns3::ApWifiMac"

Attributes

BeaconInterval: Delay between two beacons
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +102400000.0ns
- Flags: construct write read
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: construct write read
EnableBeaconJitter: If beacons are enabled, whether to jitter the initial send event.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
BeaconGeneration: Whether or not beacons are generated.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
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: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read

Attributes defined in parent class ns3::RegularWifiMac

QosSupported: This Boolean attribute is set to enable 802.11e/WMM-style QoS support at this STA.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
HtSupported: This Boolean attribute is set to enable 802.11n support at this STA.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
VhtSupported: This Boolean attribute is set to enable 802.11ac support at this STA.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
CtsToSelfSupported: Use CTS to Self when using a rate that is not in the basic rate set.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
VO_MaxAmsduSize: Maximum length in bytes of an A-MSDU for AC_VO access class.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write
VI_MaxAmsduSize: Maximum length in bytes of an A-MSDU for AC_VI access class.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write
BE_MaxAmsduSize: Maximum length in bytes of an A-MSDU for AC_BE access class.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write
BK_MaxAmsduSize: Maximum length in bytes of an A-MSDU for AC_BK access class.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write
VO_MaxAmpduSize: Maximum length in bytes of an A-MPDU for AC_VO access class.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write
VI_MaxAmpduSize: Maximum length in bytes of an A-MPDU for AC_VI access class.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 65535
- Flags: construct write
BE_MaxAmpduSize: Maximum length in bytes of an A-MPDU for AC_BE access class.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 65535
- Flags: construct write
BK_MaxAmpduSize: Maximum length in bytes of an A-MPDU for AC_BK access class.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 0
- Flags: construct write
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.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:64
- Initial value: 0
- Flags: construct write
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.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:64
- Initial value: 0
- Flags: construct write
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.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:64
- Initial value: 0
- Flags: construct write
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.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:64
- Initial value: 0
- Flags: construct write
VO_BlockAckInactivityTimeout: Represents max time (blocks of 1024 micro seconds) 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: construct write
VI_BlockAckInactivityTimeout: Represents max time (blocks of 1024 micro seconds) 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: construct write
BE_BlockAckInactivityTimeout: Represents max time (blocks of 1024 micro seconds) 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: construct write
BK_BlockAckInactivityTimeout: Represents max time (blocks of 1024 micro seconds) 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: construct write
ShortSlotTimeSupported: Whether or not short slot time is supported (only used by ERP APs or STAs).
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
DcaTxop: The DcaTxop object.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::DcaTxop>
- Flags: read
VO_EdcaTxopN: Queue that manages packets belonging to AC_VO access class.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::EdcaTxopN>
- Flags: read
VI_EdcaTxopN: Queue that manages packets belonging to AC_VI access class.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::EdcaTxopN>
- Flags: read
BE_EdcaTxopN: Queue that manages packets belonging to AC_BE access class.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::EdcaTxopN>
- Flags: read
BK_EdcaTxopN: Queue that manages packets belonging to AC_BK access class.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::EdcaTxopN>
- Flags: read

Attributes defined in parent class ns3::WifiMac

CtsTimeout: When this timeout expires, the RTS/CTS handshake has failed.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +75000.0ns
- Flags: construct write read
AckTimeout: When this timeout expires, the DATA/ACK handshake has failed.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +75000.0ns
- Flags: construct write read
BasicBlockAckTimeout: When this timeout expires, the BASIC_BLOCK_ACK_REQ/BASIC_BLOCK_ACK handshake has failed.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +281000.0ns
- Flags: construct write read
CompressedBlockAckTimeout: When this timeout expires, the COMPRESSED_BLOCK_ACK_REQ/COMPRESSED_BLOCK_ACK handshake has failed.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +107000.0ns
- Flags: construct write read
Sifs: The value of the SIFS constant.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +16000.0ns
- Flags: construct write read
EifsNoDifs: The value of EIFS-DIFS.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +60000.0ns
- Flags: construct write read
Slot: The duration of a Slot.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +9000.0ns
- Flags: construct write read
Pifs: The value of the PIFS constant.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +25000.0ns
- Flags: construct write read
Rifs: The value of the RIFS constant.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +2000.0ns
- Flags: construct write read
MaxPropagationDelay: The maximum propagation delay. Unused for now.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +3333.0ns
- Flags: construct write read
Ssid: The ssid we want to belong to.
- Set with class: SsidValue
- Underlying type: Ssid
- Initial value: default
- Flags: construct write read

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::RegularWifiMac

TxOkHeader: The header of successfully transmitted packet.
Callback signature: ns3::WifiMacHeader::TracedCallback
TxErrHeader: The header of unsuccessfully transmitted packet.
Callback signature: ns3::WifiMacHeader::TracedCallback

TraceSources defined in parent class ns3::WifiMac

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.
Callback signature: ns3::Packet::TracedCallback
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

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

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

Constructor & Destructor Documentation

ns3::ApWifiMac::ApWifiMac ( )

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

References ns3::AP, m_beaconDca, ns3::RegularWifiMac::m_dcfManager, m_enableBeaconGeneration, ns3::RegularWifiMac::m_low, ns3::RegularWifiMac::m_txMiddle, NS_LOG_FUNCTION, and ns3::RegularWifiMac::SetTypeOfStation().

Here is the call graph for this function:

ns3::ApWifiMac::~ApWifiMac ( )

virtual

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

References m_nonErpStations, m_nonHtStations, m_staList, and NS_LOG_FUNCTION.

Member Function Documentation

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

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

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

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

Here is the call graph for this function:

void ns3::ApWifiMac::DeaggregateAmsduAndForward	(	Ptr< Packet >	aggregatedPacket,
		const WifiMacHeader *	hdr
	)

privatevirtual

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

aggregatedPacket	the Packet containing the A-MSDU.
hdr	a pointer to the MAC header for `aggregatedPacket`.

Reimplemented from ns3::RegularWifiMac.

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

References ns3::MsduAggregator::Deaggregate(), ForwardDown(), ns3::RegularWifiMac::ForwardUp(), ns3::RegularWifiMac::GetAddress(), ns3::WifiMacHeader::GetQosTid(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::ApWifiMac::DoDispose ( void )

privatevirtual

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

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

References ns3::EventId::Cancel(), ns3::RegularWifiMac::DoDispose(), m_beaconDca, m_beaconEvent, m_enableBeaconGeneration, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::ApWifiMac::DoInitialize ( void )

privatevirtual

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

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

References ns3::EventId::Cancel(), ns3::RegularWifiMac::DoInitialize(), ns3::RegularWifiMac::GetAddress(), ns3::Time::GetMicroSeconds(), ns3::UniformRandomVariable::GetValue(), m_beaconDca, m_beaconEvent, m_beaconInterval, m_beaconJitter, m_enableBeaconGeneration, m_enableBeaconJitter, ns3::MicroSeconds(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::Simulator::ScheduleNow(), and SendOneBeacon().

Here is the call graph for this function:

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

virtual

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 channel access function determines that access is granted to this MAC.

Implements ns3::RegularWifiMac.

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

References ns3::MacLow::GetAddress(), ns3::RegularWifiMac::m_low, and NS_LOG_FUNCTION.

Here is the call graph for this function:

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

virtual

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 channel access function determines that access is 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::RegularWifiMac.

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

References ForwardDown(), ns3::WifiRemoteStationManager::IsAssociated(), ns3::Mac48Address::IsBroadcast(), ns3::RegularWifiMac::m_stationManager, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::ApWifiMac::ForwardDown	(	Ptr< const 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 244 of file ap-wifi-mac.cc.

References ns3::RegularWifiMac::m_qosSupported, NS_LOG_FUNCTION, and ns3::QosUtilsGetTidForPacket().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::ApWifiMac::ForwardDown	(	Ptr< const 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 270 of file ap-wifi-mac.cc.

Here is the call graph for this function:

bool ns3::ApWifiMac::GetBeaconGeneration ( void ) const

private

Return whether the AP is generating beacons.

Returns: true if beacons are periodically generated, false otherwise

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

References m_enableBeaconGeneration, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

Time ns3::ApWifiMac::GetBeaconInterval ( void ) const

Returns: the interval between two beacon transmissions.

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

References m_beaconInterval, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

CapabilityInformation ns3::ApWifiMac::GetCapabilities ( void ) const

private

Return the Capability information of the current AP.

Returns: the Capability information that we support

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

References GetShortPreambleEnabled(), GetShortSlotTimeEnabled(), ns3::CapabilityInformation::SetShortPreamble(), and ns3::CapabilityInformation::SetShortSlotTime().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ErpInformation ns3::ApWifiMac::GetErpInformation ( void ) const

private

Return the ERP information of the current AP.

Returns: the ERP information that we support

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

References GetShortPreambleEnabled(), GetUseNonErpProtection(), ns3::RegularWifiMac::m_erpSupported, m_nonErpStations, ns3::ErpInformation::SetBarkerPreambleMode(), ns3::ErpInformation::SetErpSupported(), ns3::ErpInformation::SetNonErpPresent(), and ns3::ErpInformation::SetUseProtection().

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

Here is the call graph for this function:

Here is the caller graph for this function:

HtOperations ns3::ApWifiMac::GetHtOperations ( void ) const

private

Return the HT operations of the current AP.

Returns: the HT operations that we support

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

References ns3::RegularWifiMac::m_htSupported, m_nonHtStations, ns3::MIXED_MODE_PROTECTION, ns3::NO_PROTECTION, ns3::HtOperations::SetHtProtection(), and ns3::HtOperations::SetHtSupported().

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

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::ApWifiMac::GetShortPreambleEnabled ( void ) const

Determine whether short preamble should be enabled or not in the BSS.

Typically, true is returned only when the AP and all associated stations support short PLCP preamble.

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

References ns3::WifiPhy::GetShortPlcpPreambleSupported(), ns3::WifiRemoteStationManager::GetShortPreambleSupported(), ns3::RegularWifiMac::m_erpSupported, m_nonErpStations, ns3::RegularWifiMac::m_phy, and ns3::RegularWifiMac::m_stationManager.

Referenced by GetCapabilities(), GetErpInformation(), SendOneBeacon(), and SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::ApWifiMac::GetShortSlotTimeEnabled ( void ) const

Determine whether short slot time should be enabled or not in the BSS.

Typically, true is returned only when there is no non-erp stations 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, false is returned.

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

References ns3::RegularWifiMac::GetShortSlotTimeSupported(), ns3::WifiRemoteStationManager::GetShortSlotTimeSupported(), ns3::RegularWifiMac::m_erpSupported, m_nonErpStations, m_staList, and ns3::RegularWifiMac::m_stationManager.

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

Here is the call graph for this function:

Here is the caller graph for this function:

SupportedRates ns3::ApWifiMac::GetSupportedRates ( void ) const

private

Return an instance of SupportedRates that contains all rates that we support including HT rates.

Returns: SupportedRates all rates that we support

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

References ns3::WifiRemoteStationManager::AddBasicMode(), ns3::SupportedRates::AddSupportedRate(), ns3::WifiRemoteStationManager::GetBasicMode(), ns3::WifiPhy::GetBssMembershipSelector(), ns3::WifiPhy::GetChannelWidth(), ns3::WifiMode::GetDataRate(), ns3::WifiPhy::GetMode(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetNBasicModes(), ns3::WifiPhy::GetNBssMembershipSelectors(), ns3::WifiPhy::GetNModes(), ns3::WifiMode::GetUniqueName(), ns3::WifiMode::IsMandatory(), ns3::RegularWifiMac::m_htSupported, ns3::RegularWifiMac::m_phy, ns3::RegularWifiMac::m_stationManager, ns3::RegularWifiMac::m_vhtSupported, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::SupportedRates::SetBasicRate(), and ns3::WIFI_MOD_CLASS_HR_DSSS.

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

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::ApWifiMac::GetTypeId ( void )

static

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

References GetBeaconGeneration(), GetBeaconInterval(), m_beaconJitter, m_enableBeaconJitter, m_enableNonErpProtection, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakePointerAccessor(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MicroSeconds(), SetBeaconGeneration(), SetBeaconInterval(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

bool ns3::ApWifiMac::GetUseNonErpProtection ( void ) const

private

Return whether protection for non-ERP stations is used in the BSS.

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

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

References m_enableNonErpProtection, m_nonErpStations, ns3::RegularWifiMac::m_stationManager, and ns3::WifiRemoteStationManager::SetUseNonErpProtection().

Referenced by GetErpInformation().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::ApWifiMac::Receive	(	Ptr< Packet >	packet,
		const WifiMacHeader *	hdr
	)

privatevirtual

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

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

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

Parameters

packet	the packet that has been received.
hdr	a pointer to the MAC header of the received frame.

Reimplemented from ns3::RegularWifiMac.

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

void ns3::ApWifiMac::SendAssocResp	(	Mac48Address	to,
		bool	success
	)

private

Forward an association response packet to the DCF.

The standard is not clear on the correct queue for management frames if QoS is supported. We always use the DCF.

Parameters

to	the address of the STA we are sending an association response to
success	indicates whether the association was successful or not

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

References ns3::Packet::AddHeader(), ns3::RegularWifiMac::GetAddress(), GetCapabilities(), GetErpInformation(), ns3::RegularWifiMac::GetHtCapabilities(), GetHtOperations(), GetSupportedRates(), ns3::RegularWifiMac::GetVhtCapabilities(), ns3::RegularWifiMac::m_dca, ns3::RegularWifiMac::m_erpSupported, ns3::RegularWifiMac::m_htSupported, m_staList, ns3::RegularWifiMac::m_vhtSupported, NS_LOG_FUNCTION, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetAssocResp(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::StatusCode::SetFailure(), ns3::WifiMacHeader::SetNoOrder(), and ns3::StatusCode::SetSuccess().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::ApWifiMac::SendOneBeacon ( void )

private

Forward a beacon packet to the beacon special DCF.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::ApWifiMac::SendProbeResp ( Mac48Address to )

private

Forward a probe response packet to the DCF.

The standard is not clear on the correct queue for management frames if QoS is supported. We always use the DCF.

Parameters

to	the address of the STA we are sending a probe response to

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

void ns3::ApWifiMac::SetAddress ( Mac48Address address )

virtual

Parameters

address the current address of this MAC layer.

Reimplemented from ns3::RegularWifiMac.

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

References NS_LOG_FUNCTION, ns3::RegularWifiMac::SetAddress(), and ns3::RegularWifiMac::SetBssid().

Here is the call graph for this function:

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 131 of file ap-wifi-mac.cc.

References ns3::EventId::Cancel(), m_beaconEvent, 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:

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

Parameters

interval the interval between two beacon transmissions.

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

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

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Parameters

linkUp the callback to invoke when the link becomes up.

Reimplemented from ns3::RegularWifiMac.

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

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

Here is the call graph for this function:

void ns3::ApWifiMac::SetWifiRemoteStationManager ( Ptr< WifiRemoteStationManager > stationManager )

virtual

Parameters

stationManager the station manager attached to this MAC.

Reimplemented from ns3::RegularWifiMac.

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

References m_beaconDca, NS_LOG_FUNCTION, and ns3::RegularWifiMac::SetWifiRemoteStationManager().

Here is the call graph for this function:

void ns3::ApWifiMac::StartBeaconing ( void )

Start beacon transmission immediately.

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

References NS_LOG_FUNCTION, and SendOneBeacon().

Here is the call graph for this function:

bool ns3::ApWifiMac::SupportsSendFrom ( void ) const

virtual

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

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

References NS_LOG_FUNCTION.

void ns3::ApWifiMac::TxFailed ( const WifiMacHeader & hdr )

privatevirtual

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

hdr	the header of the packet that we failed to sent

Reimplemented from ns3::RegularWifiMac.

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

References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::IsAssocResp(), ns3::WifiRemoteStationManager::IsWaitAssocTxOk(), ns3::RegularWifiMac::m_stationManager, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiRemoteStationManager::RecordGotAssocTxFailed(), and ns3::RegularWifiMac::TxFailed().

Here is the call graph for this function:

void ns3::ApWifiMac::TxOk ( const WifiMacHeader & hdr )

privatevirtual

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