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 ()
virtual void	Enqueue (Ptr< const Packet > packet, Mac48Address to)
virtual void	Enqueue (Ptr< const Packet > packet, Mac48Address to, Mac48Address from)
Time	GetBeaconInterval (void) const
virtual void	SetAddress (Mac48Address address)
void	SetBeaconInterval (Time interval)
virtual void	SetLinkUpCallback (Callback< void > linkUp)
virtual void	SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)
void	StartBeaconing (void)
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
Time	GetEifsNoDifs (void) const
Time	GetPifs (void) const
Time	GetSifs (void) const
Time	GetSlot (void) const
virtual Ssid	GetSsid (void) const
virtual Ptr< WifiPhy >	GetWifiPhy () const
virtual Ptr < WifiRemoteStationManager >	GetWifiRemoteStationManager () const
void	SetAckTimeout (Time ackTimeout)
virtual void	SetBasicBlockAckTimeout (Time blockAckTimeout)
virtual void	SetBssid (Mac48Address bssid)
virtual void	SetCompressedBlockAckTimeout (Time blockAckTimeout)
void	SetCtsTimeout (Time ctsTimeout)
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.
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 ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::ApWifiMac.

Private Member Functions
virtual void	DeaggregateAmsduAndForward (Ptr< Packet > aggregatedPacket, const WifiMacHeader *hdr)
virtual void	DoDispose (void)
virtual void	DoStart (void)
void	ForwardDown (Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
void	ForwardDown (Ptr< const Packet > packet, Mac48Address from, Mac48Address to, uint8_t tid)
bool	GetBeaconGeneration (void) const
SupportedRates	GetSupportedRates (void) const
virtual void	Receive (Ptr< Packet > packet, const WifiMacHeader *hdr)
void	SendAssocResp (Mac48Address to, bool success)
void	SendOneBeacon (void)
void	SendProbeResp (Mac48Address to)
void	SetBeaconGeneration (bool enable)
virtual void	TxFailed (const WifiMacHeader &hdr)
virtual void	TxOk (const WifiMacHeader &hdr)

Private Attributes
Ptr< DcaTxop >	m_beaconDca
EventId	m_beaconEvent
Time	m_beaconInterval
bool	m_enableBeaconGeneration

Additional Inherited Members
Public Types inherited from ns3::RegularWifiMac
typedef Callback< void, Ptr < Packet >, Mac48Address, Mac48Address >	ForwardUpCallback
Protected Types inherited from ns3::RegularWifiMac
typedef std::map< AcIndex, Ptr < EdcaTxopN > >	EdcaQueues
Protected Member Functions inherited from ns3::RegularWifiMac
virtual void	DeaggregateAmsduAndForward (Ptr< Packet > aggregatedPacket, const WifiMacHeader *hdr)
virtual void	DoDispose ()
virtual void	DoStart ()
virtual void	FinishConfigureStandard (enum WifiPhyStandard standard)
void	ForwardUp (Ptr< Packet > packet, Mac48Address from, Mac48Address to)
bool	GetQosSupported () const
virtual void	Receive (Ptr< Packet > packet, const WifiMacHeader *hdr)
virtual void	SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr, Mac48Address originator)
void	SetQosSupported (bool enable)
void	SetTypeOfStation (TypeOfStation type)
virtual void	TxFailed (const WifiMacHeader &hdr)
virtual void	TxOk (const WifiMacHeader &hdr)
Protected Attributes inherited from ns3::RegularWifiMac
Ptr< DcaTxop >	m_dca
DcfManager *	m_dcfManager
EdcaQueues	m_edca
ForwardUpCallback	m_forwardUp
Callback< void >	m_linkDown
Callback< void >	m_linkUp
Ptr< MacLow >	m_low
Ptr< WifiPhy >	m_phy
bool	m_qosSupported
MacRxMiddle *	m_rxMiddle
Ssid	m_ssid
Ptr< WifiRemoteStationManager >	m_stationManager
MacTxMiddle *	m_txMiddle

Detailed Description

Wi-Fi AP state machine

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

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

Constructor & Destructor Documentation

ns3::ApWifiMac::ApWifiMac ( )

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

References ns3::AP, m_beaconDca, ns3::RegularWifiMac::m_dcfManager, m_enableBeaconGeneration, ns3::RegularWifiMac::m_low, NS_LOG_FUNCTION, ns3::DcaTxop::SetAifsn(), ns3::DcaTxop::SetLow(), ns3::DcaTxop::SetManager(), ns3::DcaTxop::SetMaxCw(), ns3::DcaTxop::SetMinCw(), and ns3::RegularWifiMac::SetTypeOfStation().

Here is the call graph for this function:

ns3::ApWifiMac::~ApWifiMac ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

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

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

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

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

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

Here is the call graph for this function:

void ns3::ApWifiMac::DoStart ( void )

privatevirtual

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

References ns3::EventId::Cancel(), m_beaconDca, m_beaconEvent, m_enableBeaconGeneration, ns3::Simulator::ScheduleNow(), SendOneBeacon(), and ns3::Object::Start().

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

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

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

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

References ns3::RegularWifiMac::m_qosSupported, 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

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

private

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

References m_enableBeaconGeneration.

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

References m_beaconInterval.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

private

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

References ns3::SupportedRates::AddSupportedRate(), ns3::WifiRemoteStationManager::GetBasicMode(), ns3::WifiMode::GetDataRate(), ns3::WifiPhy::GetMode(), ns3::WifiRemoteStationManager::GetNBasicModes(), ns3::WifiPhy::GetNModes(), ns3::RegularWifiMac::m_phy, ns3::RegularWifiMac::m_stationManager, and ns3::SupportedRates::SetBasicRate().

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

This method returns the TypeId associated to ns3::ApWifiMac.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes defined for this type:

BeaconInterval: Delay between two beacons
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +102400000.0ns
- 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

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
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: TimeValue
- Underlying type: Time
- Initial value: +75000.0ns
- Flags: construct write read
AckTimeout: When this timeout expires, the DATA/ACK handshake has failed.
- Set with class: TimeValue
- Underlying type: Time
- 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: TimeValue
- Underlying type: Time
- 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: TimeValue
- Underlying type: Time
- Initial value: +99000.0ns
- Flags: construct write read
Sifs: The value of the SIFS constant.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +16000.0ns
- Flags: construct write read
EifsNoDifs: The value of EIFS-DIFS
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +60000.0ns
- Flags: construct write read
Slot: The duration of a Slot.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +9000.0ns
- Flags: construct write read
Pifs: The value of the PIFS constant.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +25000.0ns
- Flags: construct write read
MaxPropagationDelay: The maximum propagation delay. Unused for now.
- Set with class: TimeValue
- Underlying type: Time
- 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 defined for this type.
TraceSources defined in parent class ns3::RegularWifiMac:

TxOkHeader: The header of successfully transmitted packet
TxErrHeader: The header of unsuccessfully transmitted packet

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.
MacTxDrop: A packet has been dropped in the MAC layer before being queued for transmission.
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,
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,
MacRxDrop: A packet has been dropped in the MAC layer after it has been passed up from the physical layer.