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 <wifi-mac.h>

Inheritance diagram for ns3::WifiMac:

Public Member Functions
void	ConfigureStandard (enum 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	GetSifs (void) const =0

virtual Time	GetSlot (void) const =0

virtual Ssid	GetSsid (void) const =0

virtual bool	IsRxRadio (void)=0

virtual bool	IsTxRadio (void)=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	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	SetRxRadio (bool isRx, Ptr< Node > node, Ptr< Repository > repo, Ptr< PUModel > puModel, Ptr< WifiPhy > phy)=0

virtual void	SetSifs (Time sifs)=0

virtual void	SetSlot (Time slotTime)=0

virtual void	SetSsid (Ssid ssid)=0

virtual void	SetTxRadio (bool isTx)=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
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	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	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
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)

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

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

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

Protected Member Functions
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	DoDispose (void)

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Member Functions
void	Configure80211_10Mhz (void)

void	Configure80211_5Mhz ()

void	Configure80211a (void)

void	Configure80211b (void)

void	Configure80211g (void)

void	Configure80211p_CCH (void)

void	Configure80211p_SCH (void)

virtual void	FinishConfigureStandard (enum WifiPhyStandard standard)=0

Static Private Member Functions
static Time	GetDefaultBasicBlockAckDelay (void)

static Time	GetDefaultBasicBlockAckTimeout (void)

static Time	GetDefaultCompressedBlockAckDelay (void)

static Time	GetDefaultCompressedBlockAckTimeout (void)

static Time	GetDefaultCtsAckDelay (void)

static Time	GetDefaultCtsAckTimeout (void)

static Time	GetDefaultEifsNoDifs (void)

static Time	GetDefaultMaxPropagationDelay (void)

static Time	GetDefaultSifs (void)

static Time	GetDefaultSlot (void)

Private Attributes
TracedCallback< Ptr< const Packet > >	m_macPromiscRxTrace

TracedCallback< Ptr< const Packet > >	m_macRxDropTrace

TracedCallback< Ptr< const Packet > >	m_macRxTrace

TracedCallback< Ptr< const Packet > >	m_macTxDropTrace

TracedCallback< Ptr< const Packet > >	m_macTxTrace

Time	m_maxPropagationDelay

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

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.

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

Member Function Documentation

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

Parameters

standard the wifi standard to be configured

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

References FinishConfigureStandard(), NS_ASSERT, 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.

Referenced by ns3::Bug555TestCase::DoRun().

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::MeshWifiInterfaceMac, ns3::ApWifiMac, ns3::AdhocWifiMac, and ns3::StaWifiMac.

virtual void ns3::WifiMac::FinishConfigureStandard ( enum 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, and ns3::MeshWifiInterfaceMac.

Referenced by ConfigureStandard().

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

pure virtual

Returns: the current ACK timeout duration.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Config Paths

Attributes

TraceSources

Member Function Documentation

Member Data Documentation