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:

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

Public Member Functions
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	RestartAccess (void)

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

void	SetSifs (Time sifs)

void	SetSlot (Time slotTime)

virtual void	SetSsid (Ssid ssid)

virtual void	SetWifiPhy (Ptr< WifiPhy > phy)

virtual void	SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)

virtual bool	SupportsSendFrom (void) const

Public Member Functions inherited from ns3::WifiMac
void	ConfigureStandard (enum WifiPhyStandard standard)

Time	GetMaxPropagationDelay (void) const

Time	GetMsduLifetime (void) const

void	NotifyPromiscRx (Ptr< const Packet > packet)

void	NotifyRx (Ptr< const Packet > packet)

void	NotifyRxDrop (Ptr< const Packet > packet)

void	NotifyTx (Ptr< const Packet > packet)

void	NotifyTxDrop (Ptr< const Packet > packet)

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

void	SetMaxPropagationDelay (Time delay)

Public Member Functions inherited from ns3::Object
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::WifiMac
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 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	DoInitialize ()

virtual void	FinishConfigureStandard (enum WifiPhyStandard standard)

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

bool	GetQosSupported () const

bool	IsRxRadio (void)

bool	IsTxRadio (void)

virtual void	Receive (Ptr< Packet > packet, const WifiMacHeader *hdr)

virtual void	SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr, Mac48Address originator)

void	SetQosSupported (bool enable)

void	SetRxRadio (bool isRx, Ptr< Node > node, Ptr< Repository > repo, Ptr< PUModel > puModel, Ptr< WifiPhy > phy)

void	SetTxRadio (bool isTx)

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 Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (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
Ptr< Node >	m_node

double	m_probMisdetect

Time	m_snsInterval

SpectrumManager *	m_spectrumManager

TracedCallback< const WifiMacHeader & >	m_txErrCallback

Time	m_txInterval

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

Config Paths

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

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

Attributes

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
SensingTime: The sensing time of the node
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +100000000.0ns
- Flags: construct write read
TransmissionTime: The transmission time of the node
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +1000000000.0ns
- Flags: construct write read
ProbabilityMisDetect: The probability that a node mis-detects a Primary User
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0.1
- Flags: construct write 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

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.

Definition at line 51 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 242 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 192 of file regular-wifi-mac.h.

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

Reimplemented in ns3::ApWifiMac.

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

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

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.

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

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

References m_dca, m_edca, and NS_LOG_FUNCTION.

Referenced by ns3::ApWifiMac::DoDispose(), and ns3::MeshWifiInterfaceMac::DoDispose().

void ns3::RegularWifiMac::DoInitialize ( void )

protectedvirtual

This method is called only once by Object::Initialize. If the user calls Object::Initialize multiple times, DoInitialize 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.

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

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

References m_dca, m_edca, and NS_LOG_FUNCTION.

Referenced by ns3::ApWifiMac::DoInitialize().

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.

packet	the packet that has been received.
hdr	a pointer to the MAC header of the received frame.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::WifiMac

TraceSources

TraceSources defined in parent class ns3::WifiMac

Member Typedef Documentation

Member Function Documentation

Member Data Documentation