base class for all MAC-level wifi objects.This class encapsulates all the low-level MAC functionality DCA, EDCA, etc) and all the high-level MAC functionality (association/disassociation state machines). More...

#include <regular-wifi-mac.h>

Inheritance diagram for ns3::RegularWifiMac:

Collaboration diagram for ns3::RegularWifiMac:

Public Types
typedef Callback< void, Ptr < Packet >, Mac48Address, Mac48Address >	ForwardUpCallback

Public Member Functions
	RegularWifiMac ()
virtual	~RegularWifiMac ()
virtual void	Enqueue (Ptr< const Packet > packet, Mac48Address to, Mac48Address from)
virtual void	Enqueue (Ptr< const Packet > packet, Mac48Address to)=0
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	SetAddress (Mac48Address address)
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)
virtual void	SetLinkUpCallback (Callback< void > linkUp)
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)
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 ()
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::RegularWifiMac.

Protected Types
typedef std::map< AcIndex, Ptr < EdcaTxopN > >	EdcaQueues

Protected Member Functions
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 Member Functions inherited from ns3::WifiMac
void	ConfigureCCHDcf (Ptr< Dcf > dcf, uint32_t cwmin, uint32_t cwmax, enum AcIndex ac)
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)
virtual void	NotifyNewAggregate (void)

Protected Attributes
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

Private Member Functions
	RegularWifiMac (const RegularWifiMac &)
Ptr< EdcaTxopN >	GetBEQueue (void) const
Ptr< EdcaTxopN >	GetBKQueue (void) const
Ptr< DcaTxop >	GetDcaTxop (void) const
Ptr< EdcaTxopN >	GetVIQueue (void) const
Ptr< EdcaTxopN >	GetVOQueue (void) const
RegularWifiMac &	operator= (const RegularWifiMac &)
void	SetupEdcaQueue (enum AcIndex ac)

Private Attributes
TracedCallback< const WifiMacHeader & >	m_txErrCallback
TracedCallback< const WifiMacHeader & >	m_txOkCallback

Detailed Description

base class for all MAC-level wifi objects.

This class encapsulates all the low-level MAC functionality DCA, EDCA, etc) and all the high-level MAC functionality (association/disassociation state machines).

Definition at line 50 of file regular-wifi-mac.h.

Member Typedef Documentation

typedef std::map<AcIndex, Ptr<EdcaTxopN> > ns3::RegularWifiMac::EdcaQueues

protected

This type defines a mapping between an Access Category index,

and a pointer to the corresponding channel access function

Definition at line 237 of file regular-wifi-mac.h.

typedef Callback<void, Ptr<Packet>, Mac48Address, Mac48Address> ns3::RegularWifiMac::ForwardUpCallback

This type defines the callback of a higher layer that a WifiMac(-derived) object invokes to pass a packet up the stack.

Parameters

packet	the packet that has been received.
from	the MAC address of the device that sent the packet.
to	the MAC address ot the device that the packet is destined for.

Definition at line 191 of file regular-wifi-mac.h.

Constructor & Destructor Documentation

ns3::RegularWifiMac::RegularWifiMac ( )

Definition at line 43 of file regular-wifi-mac.cc.

References ns3::AC_BE, ns3::AC_BK, ns3::AC_VI, ns3::AC_VO, m_dca, m_dcfManager, m_low, m_rxMiddle, m_txMiddle, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::MacRxMiddle::Receive(), Receive(), ns3::MacRxMiddle::SetForwardCallback(), ns3::DcaTxop::SetLow(), ns3::DcaTxop::SetManager(), ns3::MacLow::SetRxCallback(), ns3::DcaTxop::SetTxFailedCallback(), ns3::DcaTxop::SetTxOkCallback(), SetupEdcaQueue(), ns3::DcfManager::SetupLowListener(), TxFailed(), and TxOk().

Here is the call graph for this function:

ns3::RegularWifiMac::~RegularWifiMac ( )

virtual

Definition at line 72 of file regular-wifi-mac.cc.

References NS_LOG_FUNCTION.

ns3::RegularWifiMac::RegularWifiMac ( const RegularWifiMac & )

private

Member Function Documentation

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

protectedvirtual

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

Parameters

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

Definition at line 525 of file regular-wifi-mac.cc.

References ns3::MsduAggregator::Deaggregate(), and ForwardUp().

Referenced by ns3::AdhocWifiMac::Receive(), and ns3::StaWifiMac::Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::RegularWifiMac::DoDispose ( void )

protectedvirtual

This method is called by Object::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::Object.

Definition at line 91 of file regular-wifi-mac.cc.

References ns3::Object::Dispose(), m_dca, m_dcfManager, m_edca, m_low, m_phy, m_rxMiddle, m_stationManager, m_txMiddle, and NS_LOG_FUNCTION.

Here is the call graph for this function:

void ns3::RegularWifiMac::DoStart ( void )

protectedvirtual

This method is called only once by Object::Start. If the user calls Object::Start multiple times, DoStart is called only the first time.

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

Reimplemented from ns3::Object.

Definition at line 78 of file regular-wifi-mac.cc.

References m_dca, m_edca, NS_LOG_FUNCTION, and ns3::Object::Start().

Here is the call graph for this function:

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

Implements ns3::WifiMac.

Reimplemented in ns3::ApWifiMac, and ns3::MeshWifiInterfaceMac.

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

References GetAddress(), and NS_FATAL_ERROR.

Here is the call graph for this function:

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

pure 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::WifiMac.

Implemented in ns3::MeshWifiInterfaceMac, ns3::ApWifiMac, ns3::AdhocWifiMac, and ns3::StaWifiMac.

void ns3::RegularWifiMac::FinishConfigureStandard ( enum WifiPhyStandard standard )

protectedvirtual

Parameters

standard the phy standard to be used

This method is called by ns3::WifiMac::ConfigureStandard to complete the configuration process for a requested phy standard.

This method may be overriden by a derived class (e.g., in order to apply DCF or EDCA parameters specific to the usage model it is dealing with), in which case the reimplementation may choose to deal with certain values in the WifiPhyStandard enumeration, and chain up to this implementation to deal with the remainder.

Implements ns3::WifiMac.

Reimplemented in ns3::MeshWifiInterfaceMac.

Definition at line 645 of file regular-wifi-mac.cc.

References ns3::AC_BE_NQOS, ns3::WifiMac::ConfigureCCHDcf(), ns3::WifiMac::ConfigureDcf(), m_dca, m_edca, NS_FATAL_ERROR, ns3::WIFI_PHY_STANDARD_80211_10MHZ, ns3::WIFI_PHY_STANDARD_80211_5MHZ, ns3::WIFI_PHY_STANDARD_80211a, ns3::WIFI_PHY_STANDARD_80211b, ns3::WIFI_PHY_STANDARD_80211g, ns3::WIFI_PHY_STANDARD_80211p_CCH, ns3::WIFI_PHY_STANDARD_80211p_SCH, and ns3::WIFI_PHY_STANDARD_holland.

Here is the call graph for this function:

void ns3::RegularWifiMac::ForwardUp	(	Ptr< Packet >	packet,
		Mac48Address	from,
		Mac48Address	to
	)

protected

Definition at line 418 of file regular-wifi-mac.cc.

References m_forwardUp, and NS_LOG_FUNCTION.

Referenced by ns3::ApWifiMac::DeaggregateAmsduAndForward(), DeaggregateAmsduAndForward(), ns3::AdhocWifiMac::Receive(), ns3::StaWifiMac::Receive(), ns3::ApWifiMac::Receive(), and ns3::MeshWifiInterfaceMac::Receive().

Here is the caller graph for this function:

Time ns3::RegularWifiMac::GetAckTimeout ( void ) const

virtual

Returns: the current ACK timeout duration.

Implements ns3::WifiMac.

Definition at line 310 of file regular-wifi-mac.cc.

References ns3::MacLow::GetAckTimeout(), and m_low.

Here is the call graph for this function:

Mac48Address ns3::RegularWifiMac::GetAddress ( void ) const

virtual

Returns: the MAC address associated to this MAC layer.

Implements ns3::WifiMac.

Definition at line 362 of file regular-wifi-mac.cc.

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

Referenced by ns3::ApWifiMac::DeaggregateAmsduAndForward(), Enqueue(), ns3::ApWifiMac::ForwardDown(), ns3::MeshWifiInterfaceMac::ForwardDown(), ns3::dot11s::HwmpProtocolMac::ForwardPerr(), ns3::dot11s::PeerManagementProtocolMac::GetAddress(), ns3::StaWifiMac::Receive(), ns3::ApWifiMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), Receive(), ns3::flame::FlameProtocolMac::Report(), ns3::dot11s::PeerManagementProtocolMac::Report(), ns3::dot11s::HwmpProtocolMac::Report(), ns3::MeshWifiInterfaceMac::Report(), SendAddBaResponse(), ns3::StaWifiMac::SendAssociationRequest(), ns3::ApWifiMac::SendAssocResp(), ns3::MeshWifiInterfaceMac::SendBeacon(), ns3::ApWifiMac::SendOneBeacon(), ns3::dot11s::PeerManagementProtocolMac::SendPeerLinkManagementFrame(), ns3::dot11s::HwmpProtocolMac::SendPrep(), ns3::dot11s::HwmpProtocolMac::SendPreq(), ns3::StaWifiMac::SendProbeRequest(), and ns3::ApWifiMac::SendProbeResp().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::RegularWifiMac::GetBasicBlockAckTimeout ( void ) const

virtual

Reimplemented from ns3::WifiMac.

Definition at line 336 of file regular-wifi-mac.cc.

References ns3::MacLow::GetBasicBlockAckTimeout(), and m_low.

Here is the call graph for this function:

Ptr< EdcaTxopN > ns3::RegularWifiMac::GetBEQueue ( void ) const

private

Accessor for the AC_BE channel access function

Definition at line 188 of file regular-wifi-mac.cc.

References ns3::AC_BE, and m_edca.

Referenced by GetTypeId().

Here is the caller graph for this function:

Ptr< EdcaTxopN > ns3::RegularWifiMac::GetBKQueue ( void ) const

private

Accessor for the AC_BK channel access function

Definition at line 194 of file regular-wifi-mac.cc.

References ns3::AC_BK, and m_edca.

Referenced by GetTypeId().

Here is the caller graph for this function:

Mac48Address ns3::RegularWifiMac::GetBssid ( void ) const

virtual

Returns: the bssid of the network this device belongs to.

Implements ns3::WifiMac.

Definition at line 388 of file regular-wifi-mac.cc.

References ns3::MacLow::GetBssid(), and m_low.

Referenced by ns3::StaWifiMac::Enqueue(), ns3::AdhocWifiMac::Enqueue(), ns3::StaWifiMac::Receive(), ns3::StaWifiMac::SendAssociationRequest(), and ns3::StaWifiMac::SetState().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::RegularWifiMac::GetCompressedBlockAckTimeout ( void ) const

virtual

Reimplemented from ns3::WifiMac.

Definition at line 349 of file regular-wifi-mac.cc.

References ns3::MacLow::GetCompressedBlockAckTimeout(), and m_low.

Here is the call graph for this function:

Time ns3::RegularWifiMac::GetCtsTimeout ( void ) const

virtual

Returns: the current CTS timeout duration.

Implements ns3::WifiMac.

Definition at line 323 of file regular-wifi-mac.cc.

References ns3::MacLow::GetCtsTimeout(), and m_low.

Here is the call graph for this function:

Ptr< DcaTxop > ns3::RegularWifiMac::GetDcaTxop ( void ) const

private

Accessor for the DCF object

Definition at line 170 of file regular-wifi-mac.cc.

References m_dca.

Referenced by GetTypeId().

Here is the caller graph for this function:

Time ns3::RegularWifiMac::GetEifsNoDifs ( void ) const

virtual

Returns: the current EIFS minus DIFS duration

Implements ns3::WifiMac.

Definition at line 284 of file regular-wifi-mac.cc.

References ns3::DcfManager::GetEifsNoDifs(), and m_dcfManager.

Referenced by ns3::dot11s::AirtimeLinkMetricCalculator::CalculateMetric().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::RegularWifiMac::GetPifs ( void ) const

virtual

Returns: the current PIFS duration.

Implements ns3::WifiMac.

Definition at line 297 of file regular-wifi-mac.cc.

References ns3::MacLow::GetPifs(), and m_low.

Referenced by ns3::dot11s::AirtimeLinkMetricCalculator::CalculateMetric().

Here is the call graph for this function:

Here is the caller graph for this function:

bool ns3::RegularWifiMac::GetQosSupported ( ) const

protected

Get accessor for the m_qosSupported member

Definition at line 243 of file regular-wifi-mac.cc.

References m_qosSupported.

Referenced by GetTypeId().

Here is the caller graph for this function:

Time ns3::RegularWifiMac::GetSifs ( void ) const

virtual

Returns: the current SIFS duration.

Implements ns3::WifiMac.

Definition at line 271 of file regular-wifi-mac.cc.

References ns3::MacLow::GetSifs(), and m_low.

Here is the call graph for this function:

Time ns3::RegularWifiMac::GetSlot ( void ) const

virtual

Returns: the current slot duration.

Implements ns3::WifiMac.

Definition at line 257 of file regular-wifi-mac.cc.

References ns3::MacLow::GetSlotTime(), and m_low.

Referenced by ns3::dot11s::AirtimeLinkMetricCalculator::CalculateMetric().

Here is the call graph for this function:

Here is the caller graph for this function:

Ssid ns3::RegularWifiMac::GetSsid ( void ) const

virtual

Returns: the ssid which this MAC layer is going to try to stay in.

Implements ns3::WifiMac.

Definition at line 375 of file regular-wifi-mac.cc.

References m_ssid.

Referenced by ns3::StaWifiMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), ns3::StaWifiMac::SendAssociationRequest(), ns3::MeshWifiInterfaceMac::SendBeacon(), ns3::ApWifiMac::SendOneBeacon(), ns3::StaWifiMac::SendProbeRequest(), and ns3::ApWifiMac::SendProbeResp().

Here is the caller graph for this function:

TypeId ns3::RegularWifiMac::GetTypeId ( void )

static

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

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

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

Attributes defined for this type:

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

TraceSources defined for this type:

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.

Reimplemented from ns3::WifiMac.

Reimplemented in ns3::MeshWifiInterfaceMac, ns3::StaWifiMac, ns3::ApWifiMac, and ns3::AdhocWifiMac.

Definition at line 599 of file regular-wifi-mac.cc.

References GetBEQueue(), GetBKQueue(), GetDcaTxop(), GetQosSupported(), GetVIQueue(), GetVOQueue(), m_txErrCallback, m_txOkCallback, ns3::MakeTraceSourceAccessor(), ns3::TypeId::SetParent(), and SetQosSupported().

Here is the call graph for this function:

Ptr< EdcaTxopN > ns3::RegularWifiMac::GetVIQueue ( void ) const

private

Accessor for the AC_VI channel access function

Definition at line 182 of file regular-wifi-mac.cc.

References ns3::AC_VI, and m_edca.

Referenced by GetTypeId().

Here is the caller graph for this function:

Ptr< EdcaTxopN > ns3::RegularWifiMac::GetVOQueue ( void ) const

private

Accessor for the AC_VO channel access function

Definition at line 176 of file regular-wifi-mac.cc.

References ns3::AC_VO, and m_edca.

Referenced by GetTypeId().

Here is the caller graph for this function:

Ptr< WifiPhy > ns3::RegularWifiMac::GetWifiPhy ( ) const

virtual

Returns: the physical layer attached to this MAC.

Definition at line 209 of file regular-wifi-mac.cc.

References m_phy.

Referenced by ns3::dot11s::AirtimeLinkMetricCalculator::CalculateMetric().

Here is the caller graph for this function:

Ptr< WifiRemoteStationManager > ns3::RegularWifiMac::GetWifiRemoteStationManager ( ) const

virtual

Returns: the station manager attached to this MAC.

Definition at line 134 of file regular-wifi-mac.cc.

References m_stationManager.

Referenced by ns3::dot11s::AirtimeLinkMetricCalculator::CalculateMetric().

Here is the caller graph for this function:

RegularWifiMac& ns3::RegularWifiMac::operator= ( const RegularWifiMac & )

private

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

protectedvirtual

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.

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

References ns3::WifiActionHeader::BLOCK_ACK, ns3::WifiActionHeader::BLOCK_ACK_ADDBA_REQUEST, ns3::WifiActionHeader::BLOCK_ACK_ADDBA_RESPONSE, ns3::WifiActionHeader::BLOCK_ACK_DELBA, ns3::WifiActionHeader::ActionValue::blockAck, ns3::MacLow::DestroyBlockAckAgreement(), ns3::WifiActionHeader::GetAction(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetAddr2(), GetAddress(), ns3::WifiActionHeader::GetCategory(), ns3::MgtAddBaResponseHeader::GetTid(), ns3::MgtDelBaHeader::GetTid(), ns3::WifiMacHeader::GetType(), ns3::WifiMacHeader::IsAction(), ns3::MgtDelBaHeader::IsByOriginator(), ns3::WifiMacHeader::IsMgt(), m_edca, m_low, m_qosSupported, NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::QosUtilsMapTidToAc(), ns3::Packet::RemoveHeader(), and SendAddBaResponse().

Referenced by RegularWifiMac().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::RegularWifiMac::SendAddBaResponse	(	const MgtAddBaRequestHeader *	reqHdr,
		Mac48Address	originator
	)

protectedvirtual

This method can be called to accept a received ADDBA Request. An ADDBA Response will be constructed and queued for transmission.

Parameters

reqHdr	a pointer to the received ADDBA Request header.
originator	the MAC address of the originator.

Definition at line 540 of file regular-wifi-mac.cc.

References ns3::Packet::AddHeader(), ns3::WifiActionHeader::BLOCK_ACK, ns3::WifiActionHeader::BLOCK_ACK_ADDBA_RESPONSE, ns3::WifiActionHeader::ActionValue::blockAck, ns3::MacLow::CreateBlockAckAgreement(), GetAddress(), ns3::MgtAddBaRequestHeader::GetStartingSequence(), ns3::MgtAddBaRequestHeader::GetTid(), ns3::MgtAddBaRequestHeader::GetTimeout(), ns3::MgtAddBaRequestHeader::IsAmsduSupported(), ns3::MgtAddBaRequestHeader::IsImmediateBlockAck(), m_edca, m_low, NS_LOG_FUNCTION, ns3::QosUtilsMapTidToAc(), ns3::WifiMacHeader::SetAction(), ns3::WifiActionHeader::SetAction(), ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::MgtAddBaResponseHeader::SetAmsduSupport(), ns3::MgtAddBaResponseHeader::SetBufferSize(), ns3::MgtAddBaResponseHeader::SetDelayedBlockAck(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::MgtAddBaResponseHeader::SetImmediateBlockAck(), ns3::MgtAddBaResponseHeader::SetStatusCode(), ns3::StatusCode::SetSuccess(), ns3::MgtAddBaResponseHeader::SetTid(), and ns3::MgtAddBaResponseHeader::SetTimeout().

Referenced by Receive().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::RegularWifiMac::SetAckTimeout ( Time ackTimeout )

virtual

Parameters

ackTimeout the duration of an ACK timeout.

Implements ns3::WifiMac.

Definition at line 303 of file regular-wifi-mac.cc.

References m_low, NS_LOG_FUNCTION, and ns3::MacLow::SetAckTimeout().

Here is the call graph for this function:

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

virtual

Parameters

address the current address of this MAC layer.

Implements ns3::WifiMac.

Reimplemented in ns3::ApWifiMac, and ns3::AdhocWifiMac.

Definition at line 355 of file regular-wifi-mac.cc.

References m_low, NS_LOG_FUNCTION, and ns3::MacLow::SetAddress().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetBasicBlockAckTimeout ( Time blockAckTimeout )

virtual

Reimplemented from ns3::WifiMac.

Definition at line 329 of file regular-wifi-mac.cc.

References m_low, NS_LOG_FUNCTION, and ns3::MacLow::SetBasicBlockAckTimeout().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetBssid ( Mac48Address bssid )

virtual

Parameters

bssid the BSSID of the network that this device belongs to.

Definition at line 381 of file regular-wifi-mac.cc.

References m_low, NS_LOG_FUNCTION, and ns3::MacLow::SetBssid().

Referenced by ns3::StaWifiMac::Receive(), ns3::AdhocWifiMac::SetAddress(), and ns3::ApWifiMac::SetAddress().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::RegularWifiMac::SetCompressedBlockAckTimeout ( Time blockAckTimeout )

virtual

Reimplemented from ns3::WifiMac.

Definition at line 342 of file regular-wifi-mac.cc.

References m_low, NS_LOG_FUNCTION, and ns3::MacLow::SetCompressedBlockAckTimeout().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetCtsTimeout ( Time ctsTimeout )

virtual

Parameters

ctsTimeout the duration of a CTS timeout.

Implements ns3::WifiMac.

Definition at line 316 of file regular-wifi-mac.cc.

References m_low, NS_LOG_FUNCTION, and ns3::MacLow::SetCtsTimeout().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetEifsNoDifs ( Time eifsNoDifs )

virtual

Parameters

eifsNoDifs the duration of an EIFS minus DIFS.

This value is used to calculate the EIFS depending on AIFSN.

Implements ns3::WifiMac.

Definition at line 277 of file regular-wifi-mac.cc.

References m_dcfManager, NS_LOG_FUNCTION, and ns3::DcfManager::SetEifsNoDifs().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetForwardUpCallback ( ForwardUpCallback upCallback )

virtual

Parameters

upCallback the callback to invoke when a packet must be forwarded up the stack.

Definition at line 215 of file regular-wifi-mac.cc.

References m_forwardUp, and NS_LOG_FUNCTION.

void ns3::RegularWifiMac::SetLinkDownCallback ( Callback< void > linkDown )

virtual

Parameters

linkDown the callback to invoke when the link becomes down.

Implements ns3::WifiMac.

Definition at line 229 of file regular-wifi-mac.cc.

References m_linkDown, and NS_LOG_FUNCTION.

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

virtual

Parameters

linkUp the callback to invoke when the link becomes up.

Implements ns3::WifiMac.

Reimplemented in ns3::MeshWifiInterfaceMac, ns3::ApWifiMac, and ns3::AdhocWifiMac.

Definition at line 222 of file regular-wifi-mac.cc.

References m_linkUp, and NS_LOG_FUNCTION.

void ns3::RegularWifiMac::SetPifs ( Time pifs )

virtual

Parameters

pifs	the pifs duration.

Implements ns3::WifiMac.

Definition at line 290 of file regular-wifi-mac.cc.

References m_low, NS_LOG_FUNCTION, and ns3::MacLow::SetPifs().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetPromisc ( void )

virtual

Sets the interface in promiscuous mode.

Enables promiscuous mode on the interface. Note that any further filtering on the incoming frame path may affect the overall behavior.

Implements ns3::WifiMac.

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

References m_low, and ns3::MacLow::SetPromisc().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetQosSupported ( bool enable )

protected

Set accessor for the m_qosSupported member

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

References m_qosSupported, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::RegularWifiMac::SetSifs ( Time sifs )

virtual

Parameters

sifs	the sifs duration

Implements ns3::WifiMac.

Definition at line 263 of file regular-wifi-mac.cc.

References m_dcfManager, m_low, NS_LOG_FUNCTION, ns3::DcfManager::SetSifs(), and ns3::MacLow::SetSifs().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetSlot ( Time slotTime )

virtual

Parameters

slotTime the slot duration

Implements ns3::WifiMac.

Definition at line 249 of file regular-wifi-mac.cc.

References m_dcfManager, m_low, NS_LOG_FUNCTION, ns3::DcfManager::SetSlot(), and ns3::MacLow::SetSlotTime().

Here is the call graph for this function:

void ns3::RegularWifiMac::SetSsid ( Ssid ssid )

virtual

Parameters

ssid	the current ssid of this MAC layer.

Implements ns3::WifiMac.

Definition at line 368 of file regular-wifi-mac.cc.

References m_ssid, and NS_LOG_FUNCTION.

void ns3::RegularWifiMac::SetTypeOfStation ( TypeOfStation type )

protected

This method is invoked by a subclass to specify what type of station it is implementing. This is something that the channel access functions (instantiated within this class as EdcaTxopN's) need to know.

Parameters

type	the type of station.

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

References m_edca, and NS_LOG_FUNCTION.

Referenced by ns3::AdhocWifiMac::AdhocWifiMac(), ns3::ApWifiMac::ApWifiMac(), ns3::MeshWifiInterfaceMac::MeshWifiInterfaceMac(), and ns3::StaWifiMac::StaWifiMac().

Here is the caller graph for this function:

void ns3::RegularWifiMac::SetupEdcaQueue ( enum AcIndex ac )

private

This method is a private utility invoked to configure the channel access function for the specified Access Category.

Parameters

ac	the Access Category index of the queue to initialise.

Definition at line 140 of file regular-wifi-mac.cc.

References m_dcfManager, m_edca, m_low, m_txMiddle, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION, ns3::EdcaTxopN::SetLow(), TxFailed(), and TxOk().

Referenced by RegularWifiMac().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::RegularWifiMac::SetWifiPhy ( Ptr< WifiPhy > phy )

virtual

Parameters

phy	the physical layer attached to this MAC.

Implements ns3::WifiMac.

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

References m_dcfManager, m_low, m_phy, NS_LOG_FUNCTION, ns3::MacLow::SetPhy(), and ns3::DcfManager::SetupPhyListener().

Here is the call graph for this function:

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

virtual

Parameters

stationManager the station manager attached to this MAC.

Implements ns3::WifiMac.

Reimplemented in ns3::ApWifiMac.

Definition at line 119 of file regular-wifi-mac.cc.

References m_dca, m_edca, m_low, m_stationManager, NS_LOG_FUNCTION, ns3::DcaTxop::SetWifiRemoteStationManager(), and ns3::MacLow::SetWifiRemoteStationManager().

Here is the call graph for this function:

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

virtual

Implements ns3::WifiMac.

Reimplemented in ns3::ApWifiMac, and ns3::MeshWifiInterfaceMac.

Definition at line 412 of file regular-wifi-mac.cc.

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

protectedvirtual

Definition at line 703 of file regular-wifi-mac.cc.

References m_txErrCallback, and NS_LOG_FUNCTION.

Referenced by RegularWifiMac(), and SetupEdcaQueue().

Here is the caller graph for this function:

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

protectedvirtual

Definition at line 696 of file regular-wifi-mac.cc.

References m_txOkCallback, and NS_LOG_FUNCTION.

Referenced by RegularWifiMac(), and SetupEdcaQueue().

Here is the caller graph for this function:

Member Data Documentation

Ptr<DcaTxop> ns3::RegularWifiMac::m_dca

protected

This holds a pointer to the DCF instance for this WifiMac - used

for transmission of frames to non-QoS peers.

Definition at line 233 of file regular-wifi-mac.h.

Referenced by DoDispose(), DoStart(), ns3::StaWifiMac::Enqueue(), ns3::AdhocWifiMac::Enqueue(), ns3::MeshWifiInterfaceMac::FinishConfigureStandard(), FinishConfigureStandard(), ns3::ApWifiMac::ForwardDown(), GetDcaTxop(), RegularWifiMac(), ns3::StaWifiMac::SendAssociationRequest(), ns3::ApWifiMac::SendAssocResp(), ns3::MeshWifiInterfaceMac::SendBeacon(), ns3::StaWifiMac::SendProbeRequest(), ns3::ApWifiMac::SendProbeResp(), and SetWifiRemoteStationManager().

DcfManager* ns3::RegularWifiMac::m_dcfManager

protected

Definition at line 220 of file regular-wifi-mac.h.

Referenced by ns3::ApWifiMac::ApWifiMac(), DoDispose(), GetEifsNoDifs(), RegularWifiMac(), SetEifsNoDifs(), SetSifs(), SetSlot(), SetupEdcaQueue(), SetWifiPhy(), and ns3::MeshWifiInterfaceMac::SwitchFrequencyChannel().

EdcaQueues ns3::RegularWifiMac::m_edca

protected

This is a map from Access Category index to the corresponding

channel access function

Definition at line 240 of file regular-wifi-mac.h.

Referenced by DoDispose(), DoStart(), ns3::StaWifiMac::Enqueue(), ns3::AdhocWifiMac::Enqueue(), FinishConfigureStandard(), ns3::ApWifiMac::ForwardDown(), ns3::MeshWifiInterfaceMac::ForwardDown(), GetBEQueue(), GetBKQueue(), GetVIQueue(), GetVOQueue(), Receive(), SendAddBaResponse(), ns3::MeshWifiInterfaceMac::SendManagementFrame(), SetTypeOfStation(), SetupEdcaQueue(), and SetWifiRemoteStationManager().

ForwardUpCallback ns3::RegularWifiMac::m_forwardUp

protected

Definition at line 225 of file regular-wifi-mac.h.

Referenced by ForwardUp(), and SetForwardUpCallback().

Callback<void> ns3::RegularWifiMac::m_linkDown

protected

Definition at line 227 of file regular-wifi-mac.h.

Referenced by SetLinkDownCallback(), and ns3::StaWifiMac::TryToEnsureAssociated().

Callback<void> ns3::RegularWifiMac::m_linkUp

protected

Definition at line 226 of file regular-wifi-mac.h.

Referenced by ns3::StaWifiMac::Receive(), and SetLinkUpCallback().

Ptr<MacLow> ns3::RegularWifiMac::m_low

protected

Ptr<WifiPhy> ns3::RegularWifiMac::m_phy

protected

Definition at line 221 of file regular-wifi-mac.h.

Referenced by DoDispose(), ns3::AdhocWifiMac::Enqueue(), ns3::MeshWifiInterfaceMac::ForwardDown(), ns3::MeshWifiInterfaceMac::GetFrequencyChannel(), ns3::StaWifiMac::GetSupportedRates(), ns3::ApWifiMac::GetSupportedRates(), ns3::MeshWifiInterfaceMac::GetSupportedRates(), GetWifiPhy(), ns3::StaWifiMac::Receive(), ns3::ApWifiMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), SetWifiPhy(), and ns3::MeshWifiInterfaceMac::SwitchFrequencyChannel().

bool ns3::RegularWifiMac::m_qosSupported

protected

This Boolean is set true iff this WifiMac is to model 802.11e/WMM style Quality of Service. It is exposed through the attribute system.

At the moment, this flag is the sole selection between QoS and non-QoS operation for the STA (whether IBSS, AP, or non-AP). Ultimately, we will want a QoS-enabled STA to be able to fall back to non-QoS operation with a non-QoS peer. This'll require further intelligence - i.e., per-association QoS state. Having a big switch seems like a good intermediate stage, however.

Definition at line 319 of file regular-wifi-mac.h.

Referenced by ns3::StaWifiMac::Enqueue(), ns3::AdhocWifiMac::Enqueue(), ns3::ApWifiMac::ForwardDown(), GetQosSupported(), Receive(), and SetQosSupported().

MacRxMiddle* ns3::RegularWifiMac::m_rxMiddle

protected

Definition at line 217 of file regular-wifi-mac.h.

Referenced by DoDispose(), and RegularWifiMac().

Ssid ns3::RegularWifiMac::m_ssid

protected

Definition at line 229 of file regular-wifi-mac.h.

Referenced by GetSsid(), and SetSsid().

Ptr<WifiRemoteStationManager> ns3::RegularWifiMac::m_stationManager

protected

Definition at line 223 of file regular-wifi-mac.h.

Referenced by ns3::MeshWifiInterfaceMac::CheckSupportedRates(), DoDispose(), ns3::AdhocWifiMac::Enqueue(), ns3::ApWifiMac::Enqueue(), ns3::MeshWifiInterfaceMac::ForwardDown(), ns3::ApWifiMac::GetSupportedRates(), ns3::MeshWifiInterfaceMac::GetSupportedRates(), GetWifiRemoteStationManager(), ns3::StaWifiMac::Receive(), ns3::ApWifiMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), SetWifiRemoteStationManager(), ns3::ApWifiMac::TxFailed(), and ns3::ApWifiMac::TxOk().

TracedCallback<const WifiMacHeader &> ns3::RegularWifiMac::m_txErrCallback

private

Definition at line 349 of file regular-wifi-mac.h.

Referenced by GetTypeId(), and TxFailed().

MacTxMiddle* ns3::RegularWifiMac::m_txMiddle

protected

Definition at line 218 of file regular-wifi-mac.h.

Referenced by DoDispose(), RegularWifiMac(), and SetupEdcaQueue().

TracedCallback<const WifiMacHeader &> ns3::RegularWifiMac::m_txOkCallback

private

Definition at line 348 of file regular-wifi-mac.h.

Referenced by GetTypeId(), and TxOk().

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation