base class for all MAC-level wifi objects. More...

#include "wifi-mac.h"

Inheritance diagram for ns3::WifiMac:

Collaboration diagram for ns3::WifiMac:

Public Member Functions
void	ConfigureStandard (WifiPhyStandard standard)

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

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

virtual Time	GetAckTimeout (void) const =0

virtual Mac48Address	GetAddress (void) const =0

virtual Time	GetBasicBlockAckTimeout (void) const

virtual Mac48Address	GetBssid (void) const =0

virtual Time	GetCompressedBlockAckTimeout (void) const

virtual Time	GetCtsTimeout (void) const =0

virtual Time	GetEifsNoDifs (void) const =0

Time	GetMaxPropagationDelay (void) const

Time	GetMsduLifetime (void) const

virtual Time	GetPifs (void) const =0

virtual Time	GetRifs (void) const =0

virtual bool	GetRifsSupported (void) const =0

virtual bool	GetShortSlotTimeSupported (void) const =0

virtual Time	GetSifs (void) const =0

virtual Time	GetSlot (void) const =0

virtual Ssid	GetSsid (void) const =0

virtual Ptr< WifiPhy >	GetWifiPhy (void) const =0

virtual Ptr< WifiRemoteStationManager >	GetWifiRemoteStationManager (void) const =0

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	ResetWifiPhy (void)=0
	remove currently attached WifiPhy device from this MAC. More...

virtual void	SetAckTimeout (Time ackTimeout)=0

virtual void	SetAddress (Mac48Address address)=0

virtual void	SetBasicBlockAckTimeout (Time blockAckTimeout)

virtual void	SetCompressedBlockAckTimeout (Time blockAckTimeout)

virtual void	SetCtsTimeout (Time ctsTimeout)=0

virtual void	SetEifsNoDifs (Time eifsNoDifs)=0

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

virtual void	SetLinkDownCallback (Callback< void > linkDown)=0

virtual void	SetLinkUpCallback (Callback< void > linkUp)=0

void	SetMaxPropagationDelay (Time delay)

virtual void	SetPifs (Time pifs)=0

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

virtual void	SetRifs (Time rifs)=0

virtual void	SetShortSlotTimeSupported (bool enable)=0

virtual void	SetSifs (Time sifs)=0

virtual void	SetSlot (Time slotTime)=0

virtual void	SetSsid (Ssid ssid)=0

virtual void	SetWifiPhy (Ptr< WifiPhy > phy)=0

virtual void	SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)=0

virtual bool	SupportsSendFrom (void) const =0

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
	Get the most derived TypeId for this Object. 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 ()
	Default 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 operator. 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)
	Get the type ID. More...

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

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

Protected Member Functions
void	ConfigureDcf (Ptr< DcaTxop > dcf, uint32_t cwmin, uint32_t cwmax, bool isDsss, AcIndex ac)

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

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

virtual void	DoInitialize (void)
	Initialize() implementation. 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...

Private Member Functions
void	Configure80211_10Mhz (void)
	This method sets 802.11 with 10Mhz channel spacing standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211_5Mhz ()
	This method sets 802.11 with 5Mhz channel spacing standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211a (void)
	This method sets 802.11a standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211ac (void)
	This method sets 802.11ac standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211ax_2_4Ghz (void)
	This method sets 802.11ax 2.4 GHz standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211ax_5Ghz (void)
	This method sets 802.11ax 5 GHz standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211b (void)
	This method sets 802.11b standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211g (void)
	This method sets 802.11g standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211n_2_4Ghz (void)
	This method sets 802.11n 2.4 GHz standards-compliant defaults for following attributes: Sifs, Rifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

void	Configure80211n_5Ghz (void)
	This method sets 802.11n 5 GHz standards-compliant defaults for following attributes: Sifs, Rifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout. More...

virtual void	FinishConfigureStandard (WifiPhyStandard standard)=0

Static Private Member Functions
static Time	GetDefaultBasicBlockAckDelay (void)
	Return the default basic block ACK delay. More...

static Time	GetDefaultBasicBlockAckTimeout (void)
	Return the default basic block ACK timeout. More...

static Time	GetDefaultCompressedBlockAckDelay (void)
	Return the default compressed block ACK delay. More...

static Time	GetDefaultCompressedBlockAckTimeout (void)
	Return the default compressed block ACK timeout. More...

static Time	GetDefaultCtsAckDelay (void)

static Time	GetDefaultCtsAckTimeout (void)

static Time	GetDefaultEifsNoDifs (void)

static Time	GetDefaultMaxPropagationDelay (void)

static Time	GetDefaultRifs (void)

static Time	GetDefaultSifs (void)

static Time	GetDefaultSlot (void)

Private Attributes
TracedCallback< Ptr< const Packet > >	m_macPromiscRxTrace
	The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). More...

TracedCallback< Ptr< const Packet > >	m_macRxDropTrace
	The trace source fired when packets coming into the "top" of the device are dropped at the MAC layer during reception. More...

TracedCallback< Ptr< const Packet > >	m_macRxTrace
	The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition). More...

TracedCallback< Ptr< const Packet > >	m_macTxDropTrace
	The trace source fired when packets coming into the "top" of the device are dropped at the MAC layer during transmission. More...

TracedCallback< Ptr< const Packet > >	m_macTxTrace
	The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission. More...

Time	m_maxPropagationDelay
	maximum propagation delay More...

Additional Inherited Members
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

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

Config Paths

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

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

Attributes

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

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

Definition at line 41 of file wifi-mac.h.

Member Function Documentation

void ns3::WifiMac::Configure80211_10Mhz ( void )

private

This method sets 802.11 with 10Mhz channel spacing standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

Definition at line 376 of file wifi-mac.cc.

References GetDefaultMaxPropagationDelay(), ns3::MicroSeconds(), NS_LOG_FUNCTION, SetAckTimeout(), SetCtsTimeout(), SetEifsNoDifs(), SetPifs(), SetSifs(), and SetSlot().

Referenced by ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211_5Mhz ( void )

private

This method sets 802.11 with 5Mhz channel spacing standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

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

References GetDefaultMaxPropagationDelay(), ns3::MicroSeconds(), NS_LOG_FUNCTION, SetAckTimeout(), SetCtsTimeout(), SetEifsNoDifs(), SetPifs(), SetSifs(), and SetSlot().

Referenced by ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211a ( void )

private

This method sets 802.11a standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

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

References GetDefaultMaxPropagationDelay(), ns3::MicroSeconds(), NS_LOG_FUNCTION, SetAckTimeout(), SetCtsTimeout(), SetEifsNoDifs(), SetPifs(), SetSifs(), and SetSlot().

Referenced by Configure80211n_5Ghz(), and ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211ac ( void )

private

This method sets 802.11ac standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

Definition at line 419 of file wifi-mac.cc.

References Configure80211n_5Ghz(), and NS_LOG_FUNCTION.

Referenced by Configure80211ax_5Ghz(), and ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211ax_2_4Ghz ( void )

private

This method sets 802.11ax 2.4 GHz standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

There is no support for short slot time.

Definition at line 426 of file wifi-mac.cc.

References Configure80211n_2_4Ghz(), and NS_LOG_FUNCTION.

Referenced by ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211ax_5Ghz ( void )

private

This method sets 802.11ax 5 GHz standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

Definition at line 433 of file wifi-mac.cc.

References Configure80211ac(), and NS_LOG_FUNCTION.

Referenced by ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211b ( void )

private

This method sets 802.11b standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

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

References GetDefaultMaxPropagationDelay(), ns3::MicroSeconds(), NS_LOG_FUNCTION, SetAckTimeout(), SetCtsTimeout(), SetEifsNoDifs(), SetPifs(), SetSifs(), and SetSlot().

Referenced by ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211g ( void )

private

This method sets 802.11g standards-compliant defaults for following attributes: Sifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

There is no support for short slot time.

Definition at line 360 of file wifi-mac.cc.

References GetDefaultMaxPropagationDelay(), ns3::MicroSeconds(), NS_LOG_FUNCTION, SetAckTimeout(), SetCtsTimeout(), SetEifsNoDifs(), SetPifs(), SetSifs(), and SetSlot().

Referenced by Configure80211n_2_4Ghz(), and ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211n_2_4Ghz ( void )

private

This method sets 802.11n 2.4 GHz standards-compliant defaults for following attributes: Sifs, Rifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

There is no support for short slot time.

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

References Configure80211g(), GetDefaultBasicBlockAckDelay(), GetDefaultMaxPropagationDelay(), GetSifs(), GetSlot(), ns3::MicroSeconds(), NS_LOG_FUNCTION, SetBasicBlockAckTimeout(), SetCompressedBlockAckTimeout(), and SetRifs().

Referenced by Configure80211ax_2_4Ghz(), and ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::Configure80211n_5Ghz ( void )

private

This method sets 802.11n 5 GHz standards-compliant defaults for following attributes: Sifs, Rifs, Slot, EifsNoDifs, Pifs, CtsTimeout, and AckTimeout.

Definition at line 409 of file wifi-mac.cc.

References Configure80211a(), GetDefaultBasicBlockAckDelay(), GetDefaultCompressedBlockAckDelay(), GetDefaultMaxPropagationDelay(), GetSifs(), GetSlot(), ns3::MicroSeconds(), NS_LOG_FUNCTION, SetBasicBlockAckTimeout(), SetCompressedBlockAckTimeout(), and SetRifs().

Referenced by Configure80211ac(), and ConfigureStandard().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::ConfigureDcf	(	Ptr< DcaTxop >	dcf,
		uint32_t	cwmin,
		uint32_t	cwmax,
		bool	isDsss,
		AcIndex	ac
	)

protected

Parameters

dcf	the DCF to be configured
cwmin	the minimum congestion window for the DCF
cwmax	the maximum congestion window for the DCF
isDsss	flag to indicate whether PHY is DSSS or HR/DSSS
ac	the access category for the DCF

Configure the DCF with appropriate values depending on the given access category.

Definition at line 440 of file wifi-mac.cc.

References ns3::AC_BE, ns3::AC_BE_NQOS, ns3::AC_BK, ns3::AC_UNDEF, ns3::AC_VI, ns3::AC_VO, ns3::MicroSeconds(), NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by ns3::RegularWifiMac::ConfigureContentionWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiMac::ConfigureStandard ( WifiPhyStandard standard )

Parameters

standard the wifi standard to be configured

This method sets standards-compliant defaults for WifiMac parameters such as sifs time, slot time, timeout values, etc., based on the standard selected.

See also: WifiMac::Configure80211a; WifiMac::Configure80211b; WifiMac::Configure80211g; WifiMac::Configure80211_10Mhz; WifiMac::Configure80211_5Mhz; WifiMac::Configure80211n_2_4Ghz; WifiMac::Configure80211n_5Ghz; WifiMac::Configure80211ac; WifiMac::Configure80211ax_2_4Ghz; WifiMac::Configure80211ax_5Ghz

Definition at line 289 of file wifi-mac.cc.

Referenced by WifiTest::CreateOne(), InterferenceHelperSequenceTest::CreateOne(), DcfImmediateAccessBroadcastTestCase::DoRun(), Bug2831TestCase::DoRun(), and ns3::WaveHelper::Install().

Here is the call graph for this function:

Here is the caller graph for this function:

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

pure 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 DCF function determines that access it granted to this MAC. The extra parameter "from" allows this device to operate in a bridged mode, forwarding received frames without altering the source address.

Implemented in ns3::RegularWifiMac, ns3::ApWifiMac, and ns3::MeshWifiInterfaceMac.

virtual void ns3::WifiMac::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 DCF function determines that access it granted to this MAC.

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

virtual void ns3::WifiMac::FinishConfigureStandard ( WifiPhyStandard standard )

privatepure virtual

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. Subclasses should implement this method to configure their dcf queues according to the requested standard.

Implemented in ns3::RegularWifiMac, ns3::OcbWifiMac, and ns3::MeshWifiInterfaceMac.

Referenced by ConfigureStandard().

Here is the caller graph for this function:

virtual Time ns3::WifiMac::GetAckTimeout ( void ) const

pure virtual

Returns: the current ACK timeout duration.

Implemented in ns3::RegularWifiMac.

Referenced by GetTypeId().

Here is the caller graph for this function:

virtual Mac48Address ns3::WifiMac::GetAddress ( void ) const

pure virtual

Returns: the MAC address associated to this MAC layer.

Implemented in ns3::RegularWifiMac.

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

virtual

Returns: the current basic block ACK timeout duration.

Reimplemented in ns3::RegularWifiMac.

Definition at line 127 of file wifi-mac.cc.

References ns3::MicroSeconds().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual Mac48Address ns3::WifiMac::GetBssid ( void ) const

pure virtual

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

Implemented in ns3::RegularWifiMac, and ns3::OcbWifiMac.

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

virtual

Returns: the current compressed block ACK timeout duration.

Reimplemented in ns3::RegularWifiMac.

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

References ns3::MicroSeconds().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual Time ns3::WifiMac::GetCtsTimeout ( void ) const

pure virtual

Returns: the current CTS timeout duration.

Implemented in ns3::RegularWifiMac.

Referenced by GetTypeId().

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultBasicBlockAckDelay ( void )

staticprivate

Return the default basic block ACK delay.

Currently it returns 250 microseconds.

Returns: the default basic block ACK delay

Definition at line 86 of file wifi-mac.cc.

References ns3::MicroSeconds().

Referenced by Configure80211n_2_4Ghz(), Configure80211n_5Ghz(), and GetDefaultBasicBlockAckTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultBasicBlockAckTimeout ( void )

staticprivate

Return the default basic block ACK timeout.

Returns: the default basic block ACK timeout

Definition at line 101 of file wifi-mac.cc.

References GetDefaultBasicBlockAckDelay(), GetDefaultMaxPropagationDelay(), GetDefaultSifs(), GetDefaultSlot(), and ns3::MicroSeconds().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultCompressedBlockAckDelay ( void )

staticprivate

Return the default compressed block ACK delay.

Currently it returns 76 microseconds.

Returns: the default compressed block ACK delay

Definition at line 93 of file wifi-mac.cc.

References ns3::MicroSeconds().

Referenced by Configure80211n_5Ghz(), and GetDefaultCompressedBlockAckTimeout().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultCompressedBlockAckTimeout ( void )

staticprivate

Return the default compressed block ACK timeout.

Returns: the default compressed block ACK timeout

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

References GetDefaultCompressedBlockAckDelay(), GetDefaultMaxPropagationDelay(), GetDefaultSifs(), GetDefaultSlot(), and ns3::MicroSeconds().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultCtsAckDelay ( void )

staticprivate

Returns: the default CTS-ACK delay

Return a default value for 802.11a at 6Mbps (44 microseconds)

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

References ns3::MicroSeconds().

Referenced by GetDefaultCtsAckTimeout(), and GetDefaultEifsNoDifs().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultCtsAckTimeout ( void )

staticprivate

Returns: the default CTS and ACK timeout

Return the default CTS and ACK timeout. Cts_Timeout and Ack_Timeout are specified in the Annex C (Formal description of MAC operation, see details on the Trsp timer setting at page 346)

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

References GetDefaultCtsAckDelay(), GetDefaultMaxPropagationDelay(), GetDefaultSifs(), GetDefaultSlot(), and ns3::MicroSeconds().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultEifsNoDifs ( void )

staticprivate

Returns: the default extended interframe space (EIFS) without DCF interframe space (DIFS)

Return default SIFS + default CTS-ACK delay

Definition at line 59 of file wifi-mac.cc.

References GetDefaultCtsAckDelay(), and GetDefaultSifs().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultMaxPropagationDelay ( void )

staticprivate

Returns: the default maximum propagation delay

By default, we get the maximum propagation delay from 1000 m and speed of light (3e8 m/s).

Definition at line 31 of file wifi-mac.cc.

References ns3::Seconds().

Referenced by Configure80211_10Mhz(), Configure80211_5Mhz(), Configure80211a(), Configure80211b(), Configure80211g(), Configure80211n_2_4Ghz(), Configure80211n_5Ghz(), GetDefaultBasicBlockAckTimeout(), GetDefaultCompressedBlockAckTimeout(), GetDefaultCtsAckTimeout(), and GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultRifs ( void )

staticprivate

Returns: the default reduced interframe space (RIFS)

Return a default RIFS value for 802.11n (2 microseconds).

Definition at line 52 of file wifi-mac.cc.

References ns3::MicroSeconds().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultSifs ( void )

staticprivate

Returns: the default short interframe space (SIFS)

Return a default SIFS value for 802.11a (16 microseconds).

Definition at line 45 of file wifi-mac.cc.

References ns3::MicroSeconds().

Referenced by GetDefaultBasicBlockAckTimeout(), GetDefaultCompressedBlockAckTimeout(), GetDefaultCtsAckTimeout(), GetDefaultEifsNoDifs(), and GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Time ns3::WifiMac::GetDefaultSlot ( void )

staticprivate

Returns: the default slot duration

Return a default slot value for 802.11a (9 microseconds).

Definition at line 38 of file wifi-mac.cc.

References ns3::MicroSeconds().

Referenced by GetDefaultBasicBlockAckTimeout(), GetDefaultCompressedBlockAckTimeout(), GetDefaultCtsAckTimeout(), and GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual Time ns3::WifiMac::GetEifsNoDifs ( void ) const

pure virtual

Returns: the current EIFS minus DIFS duration

Implemented in ns3::RegularWifiMac.

Referenced by GetTypeId().

Here is the caller graph for this function:

Time ns3::WifiMac::GetMaxPropagationDelay ( void ) const

Returns: the maximum propagation delay.

Unused for now.

Definition at line 253 of file wifi-mac.cc.

References m_maxPropagationDelay.

Time ns3::WifiMac::GetMsduLifetime ( void ) const

Returns: the maximum lifetime of an MSDU.

Unused for now.

Definition at line 247 of file wifi-mac.cc.

References ns3::Seconds().

Here is the call graph for this function:

virtual Time ns3::WifiMac::GetPifs ( void ) const

pure virtual

Returns: the current PIFS duration.

Implemented in ns3::RegularWifiMac.

Referenced by GetTypeId().

Here is the caller graph for this function:

virtual Time ns3::WifiMac::GetRifs ( void ) const

pure virtual

Returns: the current RIFS duration.

Implemented in ns3::RegularWifiMac.

Referenced by GetTypeId().

Here is the caller graph for this function:

virtual bool ns3::WifiMac::GetRifsSupported ( void ) const

pure virtual

Returns: whether the device supports RIFS capability.

Implemented in ns3::RegularWifiMac.

virtual bool ns3::WifiMac::GetShortSlotTimeSupported ( void ) const

pure virtual

Returns: whether the device supports short slot time capability.

Implemented in ns3::RegularWifiMac.

virtual Time ns3::WifiMac::GetSifs ( void ) const

pure virtual

Returns: the current SIFS duration.

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211n_2_4Ghz(), Configure80211n_5Ghz(), and GetTypeId().

Here is the caller graph for this function:

virtual Time ns3::WifiMac::GetSlot ( void ) const

pure virtual

Returns: the current slot duration.

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211n_2_4Ghz(), Configure80211n_5Ghz(), and GetTypeId().

Here is the caller graph for this function:

virtual Ssid ns3::WifiMac::GetSsid ( void ) const

pure virtual

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

Implemented in ns3::RegularWifiMac, and ns3::OcbWifiMac.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::WifiMac::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 147 of file wifi-mac.cc.

References GetAckTimeout(), GetBasicBlockAckTimeout(), GetCompressedBlockAckTimeout(), GetCtsTimeout(), GetDefaultBasicBlockAckTimeout(), GetDefaultCompressedBlockAckTimeout(), GetDefaultCtsAckTimeout(), GetDefaultEifsNoDifs(), GetDefaultMaxPropagationDelay(), GetDefaultRifs(), GetDefaultSifs(), GetDefaultSlot(), GetEifsNoDifs(), GetPifs(), GetRifs(), GetSifs(), GetSlot(), GetSsid(), m_macPromiscRxTrace, m_macRxDropTrace, m_macRxTrace, m_macTxDropTrace, m_macTxTrace, m_maxPropagationDelay, ns3::MakeSsidAccessor(), ns3::MakeSsidChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), SetAckTimeout(), SetBasicBlockAckTimeout(), SetCompressedBlockAckTimeout(), SetCtsTimeout(), SetEifsNoDifs(), ns3::TypeId::SetParent(), SetPifs(), SetRifs(), SetSifs(), SetSlot(), and SetSsid().

Here is the call graph for this function:

virtual Ptr<WifiPhy> ns3::WifiMac::GetWifiPhy ( void ) const

pure virtual

Returns: currently attached WifiPhy device

Implemented in ns3::RegularWifiMac.

virtual Ptr<WifiRemoteStationManager> ns3::WifiMac::GetWifiRemoteStationManager ( void ) const

pure virtual

Returns: the station manager attached to this MAC.

Implemented in ns3::RegularWifiMac.

void ns3::WifiMac::NotifyPromiscRx ( Ptr< const Packet > packet )

Parameters

packet the packet we received promiscuously

Public method used to fire a MacPromiscRx trace. Implemented for encapsulation purposes.

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

References m_macPromiscRxTrace.

Referenced by ns3::WaveNetDevice::ForwardUp().

Here is the caller graph for this function:

void ns3::WifiMac::NotifyRx ( Ptr< const Packet > packet )

Parameters

packet the packet we received

Public method used to fire a MacRx trace. Implemented for encapsulation purposes.

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

References m_macRxTrace.

Referenced by ns3::WaveNetDevice::ForwardUp().

Here is the caller graph for this function:

void ns3::WifiMac::NotifyRxDrop ( Ptr< const Packet > packet )

Parameters

packet the packet we received but is not destined for us

Public method used to fire a MacRxDrop trace. Implemented for encapsulation purposes.

Definition at line 283 of file wifi-mac.cc.

References m_macRxDropTrace.

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

Here is the caller graph for this function:

void ns3::WifiMac::NotifyTx ( Ptr< const Packet > packet )

Parameters

packet the packet being enqueued

Public method used to fire a MacTx trace. Implemented for encapsulation purposes. Note this trace indicates that the packet was accepted by the device only. The packet may be dropped later (e.g. if the queue is full).

Definition at line 259 of file wifi-mac.cc.

References m_macTxTrace.

void ns3::WifiMac::NotifyTxDrop ( Ptr< const Packet > packet )

Parameters

packet the packet being dropped

Public method used to fire a MacTxDrop trace. Implemented for encapsulation purposes. This trace indicates that the packet was dropped before it was transmitted (e.g. when a STA is not associated with an AP).

Definition at line 265 of file wifi-mac.cc.

References m_macTxDropTrace.

Referenced by ns3::StaWifiMac::Enqueue(), ns3::ApWifiMac::Enqueue(), ns3::RegularWifiMac::RegularWifiMac(), and ns3::RegularWifiMac::SetupEdcaQueue().

Here is the caller graph for this function:

virtual void ns3::WifiMac::ResetWifiPhy ( void )

pure virtual

remove currently attached WifiPhy device from this MAC.

Implemented in ns3::RegularWifiMac.

virtual void ns3::WifiMac::SetAckTimeout ( Time ackTimeout )

pure virtual

Parameters

ackTimeout the duration of an ACK timeout.

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211_10Mhz(), Configure80211_5Mhz(), Configure80211a(), Configure80211b(), Configure80211g(), and GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetAddress ( Mac48Address address )

pure virtual

Parameters

address the current address of this MAC layer.

Implemented in ns3::RegularWifiMac, ns3::ApWifiMac, and ns3::AdhocWifiMac.

Referenced by Bug2831TestCase::DoRun().

Here is the caller graph for this function:

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

virtual

Parameters

blockAckTimeout the duration for basic block ACK timeout.

Sets the timeout for basic block ACK.

Reimplemented in ns3::RegularWifiMac.

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

Referenced by Configure80211n_2_4Ghz(), Configure80211n_5Ghz(), and GetTypeId().

Here is the caller graph for this function:

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

virtual

Parameters

blockAckTimeout Sets the timeout for compressed block ACK.

Reimplemented in ns3::RegularWifiMac.

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

Referenced by Configure80211n_2_4Ghz(), Configure80211n_5Ghz(), and GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetCtsTimeout ( Time ctsTimeout )

pure virtual

Parameters

ctsTimeout the duration of a CTS timeout.

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211_10Mhz(), Configure80211_5Mhz(), Configure80211a(), Configure80211b(), Configure80211g(), and GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetEifsNoDifs ( Time eifsNoDifs )

pure virtual

Parameters

eifsNoDifs the duration of an EIFS minus DIFS.

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

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211_10Mhz(), Configure80211_5Mhz(), Configure80211a(), Configure80211b(), Configure80211g(), and GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetForwardUpCallback ( Callback< void, Ptr< Packet >, Mac48Address, Mac48Address > upCallback )

pure virtual

Parameters

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

virtual void ns3::WifiMac::SetLinkDownCallback ( Callback< void > linkDown )

pure virtual

Parameters

linkDown the callback to invoke when the link becomes down.

Implemented in ns3::RegularWifiMac, and ns3::OcbWifiMac.

virtual void ns3::WifiMac::SetLinkUpCallback ( Callback< void > linkUp )

pure virtual

Parameters

linkUp the callback to invoke when the link becomes up.

Implemented in ns3::RegularWifiMac, ns3::OcbWifiMac, ns3::MeshWifiInterfaceMac, ns3::ApWifiMac, and ns3::AdhocWifiMac.

void ns3::WifiMac::SetMaxPropagationDelay ( Time delay )

Parameters

delay the max propagation delay.

Unused for now.

Definition at line 240 of file wifi-mac.cc.

References m_maxPropagationDelay, and NS_LOG_FUNCTION.

virtual void ns3::WifiMac::SetPifs ( Time pifs )

pure virtual

Parameters

pifs	the pifs duration.

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211_10Mhz(), Configure80211_5Mhz(), Configure80211a(), Configure80211b(), Configure80211g(), and GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetPromisc ( void )

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

Implemented in ns3::RegularWifiMac.

virtual void ns3::WifiMac::SetRifs ( Time rifs )

pure virtual

Parameters

rifs	the rifs duration.

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211n_2_4Ghz(), Configure80211n_5Ghz(), and GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetShortSlotTimeSupported ( bool enable )

pure virtual

Parameters

enable true if short slot time is to be supported, false otherwise

Implemented in ns3::RegularWifiMac.

virtual void ns3::WifiMac::SetSifs ( Time sifs )

pure virtual

Parameters

sifs	the sifs duration

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211_10Mhz(), Configure80211_5Mhz(), Configure80211a(), Configure80211b(), Configure80211g(), and GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetSlot ( Time slotTime )

pure virtual

Parameters

slotTime the slot duration

Implemented in ns3::RegularWifiMac.

Referenced by Configure80211_10Mhz(), Configure80211_5Mhz(), Configure80211a(), Configure80211b(), Configure80211g(), and GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetSsid ( Ssid ssid )

pure virtual

Parameters

ssid	the current ssid of this MAC layer.

Implemented in ns3::RegularWifiMac, and ns3::OcbWifiMac.

Referenced by GetTypeId().

Here is the caller graph for this function:

virtual void ns3::WifiMac::SetWifiPhy ( Ptr< WifiPhy > phy )

pure virtual

Parameters

phy	the physical layer attached to this MAC.

Implemented in ns3::RegularWifiMac, and ns3::StaWifiMac.

virtual void ns3::WifiMac::SetWifiRemoteStationManager ( Ptr< WifiRemoteStationManager > stationManager )

pure virtual

Parameters

stationManager the station manager attached to this MAC.

Implemented in ns3::RegularWifiMac, and ns3::ApWifiMac.

virtual bool ns3::WifiMac::SupportsSendFrom ( void ) const

pure virtual

Returns: if this MAC supports sending from arbitrary address.

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

Implemented in ns3::RegularWifiMac, ns3::ApWifiMac, and ns3::MeshWifiInterfaceMac.

Member Data Documentation

TracedCallback<Ptr<const Packet> > ns3::WifiMac::m_macPromiscRxTrace

private

The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition).

This is a promiscuous trace.

See also: class CallBackTraceSource

Definition at line 488 of file wifi-mac.h.

Referenced by GetTypeId(), and NotifyPromiscRx().

TracedCallback<Ptr<const Packet> > ns3::WifiMac::m_macRxDropTrace

private

The trace source fired when packets coming into the "top" of the device are dropped at the MAC layer during reception.

See also: class CallBackTraceSource

Definition at line 503 of file wifi-mac.h.

Referenced by GetTypeId(), and NotifyRxDrop().

TracedCallback<Ptr<const Packet> > ns3::WifiMac::m_macRxTrace

private

The trace source fired for packets successfully received by the device immediately before being forwarded up to higher layers (at the L2/L3 transition).

This is a non- promiscuous trace.

See also: class CallBackTraceSource

Definition at line 496 of file wifi-mac.h.

Referenced by GetTypeId(), and NotifyRx().

TracedCallback<Ptr<const Packet> > ns3::WifiMac::m_macTxDropTrace

private

The trace source fired when packets coming into the "top" of the device are dropped at the MAC layer during transmission.

See also: class CallBackTraceSource

Definition at line 480 of file wifi-mac.h.

Referenced by GetTypeId(), and NotifyTxDrop().

TracedCallback<Ptr<const Packet> > ns3::WifiMac::m_macTxTrace

private

The trace source fired when packets come into the "top" of the device at the L3/L2 transition, before being queued for transmission.

See also: class CallBackTraceSource

Definition at line 473 of file wifi-mac.h.

Referenced by GetTypeId(), and NotifyTx().

Time ns3::WifiMac::m_maxPropagationDelay

private

maximum propagation delay

Definition at line 411 of file wifi-mac.h.

Referenced by GetMaxPropagationDelay(), GetTypeId(), and SetMaxPropagationDelay().

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

TraceSources

Member Function Documentation

Member Data Documentation