The Wifi MAC high model for a non-AP STA in a BSS. More...

#include "sta-wifi-mac.h"

Inheritance diagram for ns3::StaWifiMac:

Collaboration diagram for ns3::StaWifiMac:

Public Member Functions
	StaWifiMac ()

virtual	~StaWifiMac ()

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

void	SetAssocRequestTimeout (Time timeout)

void	SetMaxMissedBeacons (uint32_t missed)

void	SetProbeRequestTimeout (Time timeout)

void	StartActiveAssociation (void)
	Start an active association sequence immediately. More...

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

virtual	~RegularWifiMac ()

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

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	SetAddress (Mac48Address address)

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)

virtual void	SetLinkUpCallback (Callback< void > linkUp)

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)

virtual void	SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)

virtual bool	SupportsSendFrom (void) const

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

bool	IsInitialized (void) const
	Check if the object has been initialized. 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 Types
enum	MacState { ASSOCIATED, WAIT_PROBE_RESP, WAIT_ASSOC_RESP, BEACON_MISSED, REFUSED }
	The current MAC state of the STA. More...

Private Member Functions
void	AssocRequestTimeout (void)
	This method is called after the association timeout occurred. More...

bool	GetActiveProbing (void) const
	Return whether active probing is enabled. More...

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

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

bool	IsAssociated (void) const
	Return whether we are associated with an AP. More...

bool	IsWaitAssocResp (void) const
	Return whether we are waiting for an association response from an AP. More...

void	MissedBeacons (void)
	This method is called after we have not received a beacon from the AP. More...

void	ProbeRequestTimeout (void)
	This method is called after the probe request timeout occurred. 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	RestartBeaconWatchdog (Time delay)
	Restarts the beacon timer. More...

void	SendAssociationRequest (void)
	Forward an association request packet to the DCF. More...

void	SendProbeRequest (void)
	Forward a probe request packet to the DCF. More...

void	SetActiveProbing (bool enable)
	Enable or disable active probing. More...

void	SetEdcaParameters (AcIndex ac, uint8_t cwMin, uint8_t cwMax, uint8_t aifsn, Time txopLimit)
	Set the EDCA parameters. More...

void	SetState (enum MacState value)
	Set the current MAC state. More...

void	TryToEnsureAssociated (void)
	Try to ensure that we are associated with an AP by taking an appropriate action depending on the current association status. More...

Private Attributes
bool	m_activeProbing

TracedCallback< Mac48Address >	m_assocLogger

EventId	m_assocRequestEvent

Time	m_assocRequestTimeout

EventId	m_beaconWatchdog

Time	m_beaconWatchdogEnd

TracedCallback< Mac48Address >	m_deAssocLogger

uint32_t	m_maxMissedBeacons

EventId	m_probeRequestEvent

Time	m_probeRequestTimeout

enum MacState	m_state

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	DeaggregateAmsduAndForward (Ptr< Packet > aggregatedPacket, const WifiMacHeader *hdr)
	This method can be called to de-aggregate an A-MSDU and forward the constituent packets up the stack. More...

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

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

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	GetDsssSupported () const
	Return whether the device supports DSSS. 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	SetDsssSupported (bool enable)
	Enable or disable DSSS support for the device. 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...

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

Protected Member Functions inherited from ns3::WifiMac
void	ConfigureDcf (Ptr< Dcf > dcf, uint32_t cwmin, uint32_t cwmax, bool isDsss, 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...

bool	m_dsssSupported
	This Boolean is set `true` iff this WifiMac is to model 802.11b. 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

The Wifi MAC high model for a non-AP STA in a BSS.

Config Paths

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

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

Attributes

ProbeRequestTimeout: The interval between two consecutive probe request attempts.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +50000000.0ns
- Flags: construct write read
AssocRequestTimeout: The interval between two consecutive assoc request attempts.
- Set with class: ns3::TimeValue
- Underlying type: Time –9223372036854775808.0ns:+9223372036854775807.0ns
- Initial value: +500000000.0ns
- Flags: construct write read
MaxMissedBeacons: Number of beacons which much be consecutively missed before we attempt to restart association.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
ActiveProbing: If true, we send probe requests. If false, we don't.NOTE: if more than one STA in your simulation is using active probing, you should enable it at a different simulation time for each STA, otherwise all the STAs will start sending probes at the same time resulting in collisions. See bug 1060 for more info.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- 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

TraceSources

Assoc: Associated with an access point.
Callback signature: ns3::Mac48Address::TracedCallback
DeAssoc: Association with an access point lost.
Callback signature: ns3::Mac48Address::TracedCallback

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 512 bytes (on a 64-bit architecture).

Definition at line 42 of file sta-wifi-mac.h.

Constructor & Destructor Documentation

ns3::StaWifiMac::StaWifiMac ( )

Definition at line 104 of file sta-wifi-mac.cc.

References NS_LOG_FUNCTION, ns3::RegularWifiMac::SetTypeOfStation(), and ns3::STA.

Here is the call graph for this function:

ns3::StaWifiMac::~StaWifiMac ( )

virtual

Definition at line 117 of file sta-wifi-mac.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::StaWifiMac::AssocRequestTimeout ( void )

private

This method is called after the association timeout occurred.

We switch the state to WAIT_ASSOC_RESP and re-send an association request.

Definition at line 296 of file sta-wifi-mac.cc.

References NS_LOG_FUNCTION, SendAssociationRequest(), SetState(), and WAIT_ASSOC_RESP.

Referenced by SendAssociationRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::StaWifiMac::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 356 of file sta-wifi-mac.cc.

Here is the call graph for this function:

bool ns3::StaWifiMac::GetActiveProbing ( void ) const

private

Return whether active probing is enabled.

Returns: true if active probing is enabled, false otherwise

Definition at line 165 of file sta-wifi-mac.cc.

References m_activeProbing.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

private

Return the Capability information of the current STA.

Returns: the Capability information that we support

Definition at line 811 of file sta-wifi-mac.cc.

References ns3::WifiPhy::GetShortPlcpPreambleSupported(), ns3::RegularWifiMac::GetShortSlotTimeSupported(), ns3::RegularWifiMac::m_erpSupported, ns3::RegularWifiMac::m_phy, ns3::CapabilityInformation::SetShortPreamble(), and ns3::CapabilityInformation::SetShortSlotTime().

Referenced by SendAssociationRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

SupportedRates ns3::StaWifiMac::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 789 of file sta-wifi-mac.cc.

References ns3::SupportedRates::AddBssMembershipSelectorRate(), ns3::SupportedRates::AddSupportedRate(), ns3::WifiPhy::GetBssMembershipSelector(), ns3::WifiPhy::GetChannelWidth(), ns3::WifiMode::GetDataRate(), ns3::WifiPhy::GetMode(), ns3::WifiPhy::GetNBssMembershipSelectors(), ns3::WifiPhy::GetNModes(), ns3::RegularWifiMac::m_htSupported, ns3::RegularWifiMac::m_phy, ns3::RegularWifiMac::m_vhtSupported, and NS_LOG_DEBUG.

Referenced by SendAssociationRequest(), and SendProbeRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeId ns3::StaWifiMac::GetTypeId ( void )

static

Definition at line 65 of file sta-wifi-mac.cc.

References GetActiveProbing(), m_assocLogger, m_assocRequestTimeout, m_deAssocLogger, m_maxMissedBeacons, m_probeRequestTimeout, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::Seconds(), SetActiveProbing(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

bool ns3::StaWifiMac::IsAssociated ( void ) const

private

Return whether we are associated with an AP.

Returns: true if we are associated with an AP, false otherwise

Definition at line 344 of file sta-wifi-mac.cc.

References ASSOCIATED, and m_state.

Referenced by Enqueue(), and Receive().

Here is the caller graph for this function:

bool ns3::StaWifiMac::IsWaitAssocResp ( void ) const

private

Return whether we are waiting for an association response from an AP.

Returns: true if we are waiting for an association response from an AP, false otherwise

Definition at line 350 of file sta-wifi-mac.cc.

References m_state, and WAIT_ASSOC_RESP.

Referenced by Receive().

Here is the caller graph for this function:

void ns3::StaWifiMac::MissedBeacons ( void )

private

This method is called after we have not received a beacon from the AP.

Definition at line 312 of file sta-wifi-mac.cc.

References BEACON_MISSED, ns3::EventId::Cancel(), ns3::EventId::IsRunning(), m_beaconWatchdog, m_beaconWatchdogEnd, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), SetState(), and TryToEnsureAssociated().

Referenced by RestartBeaconWatchdog().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::StaWifiMac::ProbeRequestTimeout ( void )

private

This method is called after the probe request timeout occurred.

We switch the state to WAIT_PROBE_RESP and re-send a probe request.

Definition at line 304 of file sta-wifi-mac.cc.

References NS_LOG_FUNCTION, SendProbeRequest(), SetState(), and WAIT_PROBE_RESP.

Referenced by SendProbeRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::StaWifiMac::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 426 of file sta-wifi-mac.cc.

void ns3::StaWifiMac::RestartBeaconWatchdog ( Time delay )

private

Restarts the beacon timer.

Parameters

delay the delay before the watchdog fires

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

References ns3::Simulator::GetDelayLeft(), ns3::EventId::IsExpired(), m_beaconWatchdog, m_beaconWatchdogEnd, max, MissedBeacons(), ns3::Simulator::Now(), 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:

void ns3::StaWifiMac::SendAssociationRequest ( void )

private

Forward an association request 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.

Definition at line 211 of file sta-wifi-mac.cc.

References ns3::Packet::AddHeader(), AssocRequestTimeout(), ns3::EventId::Cancel(), ns3::RegularWifiMac::GetAddress(), ns3::RegularWifiMac::GetBssid(), GetCapabilities(), ns3::RegularWifiMac::GetHtCapabilities(), ns3::RegularWifiMac::GetSsid(), GetSupportedRates(), ns3::RegularWifiMac::GetVhtCapabilities(), ns3::EventId::IsRunning(), m_assocRequestEvent, m_assocRequestTimeout, ns3::RegularWifiMac::m_dca, ns3::RegularWifiMac::m_htSupported, ns3::RegularWifiMac::m_vhtSupported, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetAssocReq(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetNoOrder(), and ns3::MgtAssocRequestHeader::SetSsid().

Referenced by AssocRequestTimeout(), and Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::StaWifiMac::SendProbeRequest ( void )

private

Forward a probe request 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.

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

References ns3::Packet::AddHeader(), ns3::EventId::Cancel(), ns3::RegularWifiMac::GetAddress(), ns3::Mac48Address::GetBroadcast(), ns3::RegularWifiMac::GetHtCapabilities(), ns3::RegularWifiMac::GetSsid(), GetSupportedRates(), ns3::RegularWifiMac::GetVhtCapabilities(), ns3::EventId::IsRunning(), ns3::RegularWifiMac::m_dca, ns3::RegularWifiMac::m_htSupported, m_probeRequestEvent, m_probeRequestTimeout, ns3::RegularWifiMac::m_vhtSupported, NS_LOG_FUNCTION, ProbeRequestTimeout(), ns3::Simulator::Schedule(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetNoOrder(), ns3::WifiMacHeader::SetProbeReq(), and ns3::MgtProbeRequestHeader::SetSsid().

Referenced by ProbeRequestTimeout(), and TryToEnsureAssociated().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::StaWifiMac::SetActiveProbing ( bool enable )

private

Enable or disable active probing.

Parameters

enable enable or disable active probing

Definition at line 151 of file sta-wifi-mac.cc.

References ns3::EventId::Cancel(), m_activeProbing, m_probeRequestEvent, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and TryToEnsureAssociated().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::StaWifiMac::SetAssocRequestTimeout ( Time timeout )

Parameters

timeout If no association response is received within the specified timeout, the station sends a new association request.

Definition at line 137 of file sta-wifi-mac.cc.

References m_assocRequestTimeout, NS_LOG_FUNCTION, and timeout.

void ns3::StaWifiMac::SetEdcaParameters	(	AcIndex	ac,
		uint8_t	cwMin,
		uint8_t	cwMax,
		uint8_t	aifsn,
		Time	txopLimit
	)

private

Set the EDCA parameters.

Parameters

ac	the access class
cwMin	the minimum contention window size
cwMax	the maximum contention window size
aifsn	the number of slots that make up an AIFS
txopLimit	the TXOP limit