Basic MAC of mesh point Wi-Fi interface. More...

#include "mesh-wifi-interface-mac.h"

Inheritance diagram for ns3::MeshWifiInterfaceMac:

Collaboration diagram for ns3::MeshWifiInterfaceMac:

Classes
struct	Statistics
	Statistics: More...

Public Member Functions
	MeshWifiInterfaceMac ()
	C-tor.

	~MeshWifiInterfaceMac () override
	D-tor.

int64_t	AssignStreams (int64_t stream) override
	Assign a fixed random variable stream number to the random variables used by this model.

bool	CanForwardPacketsTo (Mac48Address to) const override
	Return true if packets can be forwarded to the given destination, false otherwise.

bool	CheckSupportedRates (AllSupportedRates rates) const
	Check supported rates.

void	ConfigureContentionWindow (uint32_t cwMin, uint32_t cwMax) override

uint16_t	GetFrequencyChannel () const
	Current channel Id.

AllSupportedRates	GetSupportedRates () const
	Get supported rates.

void	InstallPlugin (Ptr< MeshWifiInterfaceMacPlugin > plugin)
	Install plugin.

void	Report (std::ostream &os) const
	Report statistics.

void	ResetStats ()
	Reset statistics function.

void	SendManagementFrame (Ptr< Packet > frame, const WifiMacHeader &hdr)
	To be used by plugins sending management frames.

void	SetBeaconGeneration (bool enable)
	Enable/disable beacons.

void	SetLinkUpCallback (Callback< void > linkUp) override

bool	SupportsSendFrom () const override

void	SwitchFrequencyChannel (uint16_t new_id)
	Switch frequency channel.

Each mesh point interface must know the mesh point address
void	SetMeshPointAddress (Mac48Address addr)
	Set the mesh point address.

Mac48Address	GetMeshPointAddress () const
	Get the mesh point address.

Beacons
void	SetRandomStartDelay (Time interval)
	Set maximum initial random delay before first beacon.

void	SetBeaconInterval (Time interval)
	Set interval between two successive beacons.

Time	GetBeaconInterval () const
	Get beacon interval.

Time	GetTbtt () const
	Next beacon frame time.

void	ShiftTbtt (Time shift)
	Shift TBTT.

Metric Calculation routines:
void	SetLinkMetricCallback (Callback< uint32_t, Mac48Address, Ptr< MeshWifiInterfaceMac > > cb)
	Set the link metric callback.

uint32_t	GetLinkMetric (Mac48Address peerAddress)
	Get the link metric.

Public Member Functions inherited from ns3::WifiMac
	WifiMac ()

	WifiMac (const WifiMac &)=delete

	~WifiMac () override

void	BlockUnicastTxOnLinks (WifiQueueBlockedReason reason, const Mac48Address &address, const std::set< uint8_t > &linkIds)
	Block the transmission on the given links of all unicast frames addressed to the station with the given address for the given reason.

void	Enqueue (Ptr< Packet > packet, Mac48Address to)

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

void	Enqueue (Ptr< Packet > packet, Mac48Address to, Mac48Address from, uint8_t tid)

Mac48Address	GetAddress () const

OriginatorAgreementOptConstRef	GetBaAgreementEstablishedAsOriginator (Mac48Address recipient, uint8_t tid) const

RecipientAgreementOptConstRef	GetBaAgreementEstablishedAsRecipient (Mac48Address originator, uint8_t tid) const

BlockAckReqType	GetBarTypeAsOriginator (const Mac48Address &recipient, uint8_t tid) const

BlockAckReqType	GetBarTypeAsRecipient (Mac48Address originator, uint8_t tid) const

BlockAckType	GetBaTypeAsOriginator (const Mac48Address &recipient, uint8_t tid) const

BlockAckType	GetBaTypeAsRecipient (Mac48Address originator, uint8_t tid) const

Mac48Address	GetBssid (uint8_t linkId) const

Ptr< ChannelAccessManager >	GetChannelAccessManager (uint8_t linkId=SINGLE_LINK_OP_ID) const
	Get the Channel Access Manager associated with the given link.

Ptr< WifiNetDevice >	GetDevice () const
	Return the device this PHY is associated with.

bool	GetDsssSupported (uint8_t linkId) const
	Return whether the device supports DSSS on the given link.

EhtCapabilities	GetEhtCapabilities (uint8_t linkId) const
	Return the EHT capabilities of the device for the given link.

Ptr< EhtConfiguration >	GetEhtConfiguration () const

bool	GetEhtSupported () const
	Return whether the device supports EHT.

bool	GetEhtSupported (const Mac48Address &address) const

bool	GetErpSupported (uint8_t linkId) const
	Return whether the device supports ERP on the given link.

ExtendedCapabilities	GetExtendedCapabilities () const
	Return the extended capabilities of the device.

Ptr< FrameExchangeManager >	GetFrameExchangeManager (uint8_t linkId=SINGLE_LINK_OP_ID) const
	Get the Frame Exchange Manager associated with the given link.

He6GhzBandCapabilities	GetHe6GhzBandCapabilities (uint8_t linkId) const
	Return the HE 6GHz band capabilities of the device for the given 6 GHz link.

HeCapabilities	GetHeCapabilities (uint8_t linkId) const
	Return the HE capabilities of the device for the given link.

Ptr< HeConfiguration >	GetHeConfiguration () const

bool	GetHeSupported () const
	Return whether the device supports HE.

bool	GetHeSupported (const Mac48Address &address) const

HtCapabilities	GetHtCapabilities (uint8_t linkId) const
	Return the HT capabilities of the device for the given link.

Ptr< HtConfiguration >	GetHtConfiguration () const

bool	GetHtSupported (const Mac48Address &address) const

bool	GetHtSupported (uint8_t linkId) const
	Return whether the device supports HT on the given link.

std::optional< uint8_t >	GetLinkForPhy (Ptr< const WifiPhy > phy) const
	Get the ID of the link (if any) on which the given PHY is operating.

std::optional< uint8_t >	GetLinkForPhy (std::size_t phyId) const
	Get the ID of the link (if any) on which the given PHY is operating.

virtual std::optional< uint8_t >	GetLinkIdByAddress (const Mac48Address &address) const
	Get the ID of the link having the given MAC address, if any.

const std::set< uint8_t > &	GetLinkIds () const

Mac48Address	GetLocalAddress (const Mac48Address &remoteAddr) const
	Get the local MAC address used to communicate with a remote STA.

Ptr< WifiMacQueueScheduler >	GetMacQueueScheduler () const
	Get the wifi MAC queue scheduler.

uint32_t	GetMaxAmpduSize (AcIndex ac) const
	Return the maximum A-MPDU size of the given Access Category.

uint16_t	GetMaxAmsduSize (AcIndex ac) const
	Return the maximum A-MSDU size of the given Access Category.

uint16_t	GetMaxBaBufferSize (std::optional< Mac48Address > address=std::nullopt) const
	Get the maximum Block Ack buffer size (in number of MPDUs) supported by the given device, if any, or by this device, otherwise, based on the supported standard.

std::optional< Mac48Address >	GetMldAddress (const Mac48Address &remoteAddr) const

uint16_t	GetMpduBufferSize () const

uint8_t	GetNLinks () const
	Get the number of links (can be greater than 1 for 11be devices only).

bool	GetQosSupported () const
	Return whether the device supports QoS.

Ptr< QosTxop >	GetQosTxop (AcIndex ac) const
	Accessor for a specified EDCA object.

Ptr< QosTxop >	GetQosTxop (uint8_t tid) const
	Accessor for a specified EDCA object.

Ssid	GetSsid () const

std::optional< std::reference_wrapper< const WifiTidLinkMapping > >	GetTidToLinkMapping (Mac48Address mldAddr, WifiDirection dir) const
	Get the TID-to-Link Mapping negotiated with the given MLD (if any) for the given direction.

bool	GetTxBlockedOnLink (AcIndex ac, const WifiContainerQueueId &queueId, uint8_t linkId, WifiQueueBlockedReason reason=WifiQueueBlockedReason::REASONS_COUNT) const
	Check whether the transmission of the packets in the given container queue of the given Access Category are blocked on the given link for the given reason (if any).

Ptr< Txop >	GetTxop () const
	Accessor for the Txop object.

virtual Ptr< WifiMacQueue >	GetTxopQueue (AcIndex ac) const
	Get the wifi MAC queue of the (Qos)Txop associated with the given AC, if such (Qos)Txop is installed, or a null pointer, otherwise.

TypeOfStation	GetTypeOfStation () const
	Return the type of station.

VhtCapabilities	GetVhtCapabilities (uint8_t linkId) const
	Return the VHT capabilities of the device for the given link.

Ptr< VhtConfiguration >	GetVhtConfiguration () const

bool	GetVhtSupported (const Mac48Address &address) const

bool	GetVhtSupported (uint8_t linkId) const
	Return whether the device supports VHT on the given link.

Ptr< WifiPhy >	GetWifiPhy (uint8_t linkId=SINGLE_LINK_OP_ID) const

Ptr< WifiRemoteStationManager >	GetWifiRemoteStationManager (uint8_t linkId=0) const

virtual bool	HasFramesToTransmit (uint8_t linkId)
	Check if the MAC has frames to transmit over the given link.

bool	Is6GhzBand (uint8_t linkId) const
	Indicate if a given link is on the 6 GHz band.

virtual void	NotifyChannelSwitching (uint8_t linkId)
	Notify that channel on the given link has been switched.

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)

WifiMac &	operator= (const WifiMac &)=delete

void	ResetWifiPhys ()
	Remove currently attached WifiPhy objects from this MAC.

virtual void	SetAddress (Mac48Address address)

void	SetBssid (Mac48Address bssid, uint8_t linkId)

void	SetChannelAccessManagers (const std::vector< Ptr< ChannelAccessManager > > &caManagers)

void	SetCtsToSelfSupported (bool enable)
	Enable or disable CTS-to-self feature.

void	SetDevice (const Ptr< WifiNetDevice > device)
	Sets the device this PHY is associated with.

void	SetForwardUpCallback (ForwardUpCallback upCallback)

void	SetFrameExchangeManagers (const std::vector< Ptr< FrameExchangeManager > > &feManagers)

void	SetLinkDownCallback (Callback< void > linkDown)

virtual void	SetMacQueueScheduler (Ptr< WifiMacQueueScheduler > scheduler)
	Set the wifi MAC queue scheduler.

void	SetMpduBufferSize (uint16_t size)

void	SetPromisc ()
	Sets the interface in promiscuous mode.

void	SetSsid (Ssid ssid)

void	SetTypeOfStation (TypeOfStation type)
	This method is invoked by a subclass to specify what type of station it is implementing.

virtual void	SetWifiPhys (const std::vector< Ptr< WifiPhy > > &phys)

void	SetWifiRemoteStationManager (Ptr< WifiRemoteStationManager > stationManager)

void	SetWifiRemoteStationManagers (const std::vector< Ptr< WifiRemoteStationManager > > &stationManagers)

bool	TidMappedOnLink (Mac48Address mldAddr, WifiDirection dir, uint8_t tid, uint8_t linkId) const
	Check whether the given TID is mapped on the given link in the given direction for the given MLD.

void	UnblockUnicastTxOnLinks (WifiQueueBlockedReason reason, const Mac48Address &address, const std::set< uint8_t > &linkIds)
	Unblock the transmission on the given links of all unicast frames addressed to the station with the given address for the given reason.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

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

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

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

Private Types
typedef std::vector< Ptr< MeshWifiInterfaceMacPlugin > >	PluginList
	PluginList typedef.

Private Member Functions
void	DoCompleteConfig () override
	Allow subclasses to complete the configuration of the MAC layer components.

void	DoDispose () override
	Real d-tor.

void	DoInitialize () override
	Initialize() implementation.

void	Enqueue (Ptr< WifiMpdu > mpdu, Mac48Address to, Mac48Address from) override

bool	GetBeaconGeneration () const
	Get current beaconing status.

void	Receive (Ptr< const WifiMpdu > mpdu, uint8_t linkId) override
	Frame receive handler.

void	ScheduleNextBeacon ()
	Schedule next beacon.

void	SendBeacon ()
	Send beacon.

Private Attributes
EventId	m_beaconSendEvent
	"Timer" for the next beacon

Ptr< UniformRandomVariable >	m_coefficient
	Add randomness to beacon generation.

Callback< uint32_t, Mac48Address, Ptr< MeshWifiInterfaceMac > >	m_linkMetricCallback
	linkMetricCallback

Mac48Address	m_mpAddress
	Mesh point address.

PluginList	m_plugins
	List of all installed plugins.

Statistics	m_stats
	statistics

Mesh timing intervals
bool	m_beaconEnable

Time	m_beaconInterval
	Beaconing interval.

Time	m_randomStart
	Maximum delay before first beacon.

Time	m_tbtt
	Time for the next frame.

Additional Inherited Members
Public Types inherited from ns3::WifiMac
typedef Callback< void, Ptr< const Packet >, Mac48Address, Mac48Address >	ForwardUpCallback
	This type defines the callback of a higher layer that a WifiMac(-derived) object invokes to pass a packet up the stack.

using	OriginatorAgreementOptConstRef
	optional const reference to OriginatorBlockAckAgreement

using	RecipientAgreementOptConstRef
	optional const reference to RecipientBlockAckAgreement

Protected Member Functions inherited from ns3::WifiMac
void	ApplyTidLinkMapping (const Mac48Address &mldAddr, WifiDirection dir)
	Apply the TID-to-Link Mapping negotiated with the given MLD for the given direction by properly configuring the queue scheduler.

virtual void	DeaggregateAmsduAndForward (Ptr< const WifiMpdu > mpdu)
	This method can be called to de-aggregate an A-MSDU and forward the constituent packets up the stack.

void	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

void	ForwardUp (Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
	Forward the packet up to the device.

Ptr< QosTxop >	GetBEQueue () const
	Accessor for the AC_BE channel access function.

Ptr< QosTxop >	GetBKQueue () const
	Accessor for the AC_BK channel access function.

LinkEntity &	GetLink (uint8_t linkId) const
	Get a reference to the link associated with the given ID.

const std::map< uint8_t, std::unique_ptr< LinkEntity > > &	GetLinks () const

bool	GetShortSlotTimeSupported () const

Ptr< QosTxop >	GetVIQueue () const
	Accessor for the AC_VI channel access function.

Ptr< QosTxop >	GetVOQueue () const
	Accessor for the AC_VO channel access function.

void	NotifyConstructionCompleted () override
	Notifier called once the ObjectBase is fully constructed.

void	SetShortSlotTimeSupported (bool enable)
	Enable or disable short slot time feature.

void	SwapLinks (std::map< uint8_t, uint8_t > links)
	Swap the links based on the information included in the given map.

void	UpdateTidToLinkMapping (const Mac48Address &mldAddr, WifiDirection dir, const WifiTidLinkMapping &mapping)
	Update the TID-to-Link Mappings for the given MLD in the given direction based on the given negotiated mappings.

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

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

Protected Attributes inherited from ns3::WifiMac
Callback< void >	m_linkDown
	Callback when a link is down.

Callback< void >	m_linkUp
	Callback when a link is up.

Ptr< MacRxMiddle >	m_rxMiddle
	RX middle (defragmentation etc.)

Ptr< WifiMacQueueScheduler >	m_scheduler
	wifi MAC queue scheduler

Ptr< MacTxMiddle >	m_txMiddle
	TX middle (aggregation etc.)

Ptr< Txop >	m_txop
	TXOP used for transmission of frames to non-QoS peers.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Basic MAC of mesh point Wi-Fi interface.

Its function is extendable through plugins mechanism.

Now only three output queues are used:

beacons (PIFS and no backoff),
background traffic,
management and priority traffic.

Definition at line 43 of file mesh-wifi-interface-mac.h.

Member Typedef Documentation

◆ PluginList

typedef std::vector<Ptr<MeshWifiInterfaceMacPlugin> > ns3::MeshWifiInterfaceMac::PluginList

private

PluginList typedef.

Definition at line 243 of file mesh-wifi-interface-mac.h.

Constructor & Destructor Documentation

◆ MeshWifiInterfaceMac()

ns3::MeshWifiInterfaceMac::MeshWifiInterfaceMac ( )

C-tor.

Definition at line 67 of file mesh-wifi-interface-mac.cc.

References ns3::CreateObject(), m_coefficient, ns3::MESH, NS_LOG_FUNCTION, and ns3::WifiMac::SetTypeOfStation().

Here is the call graph for this function:

◆ ~MeshWifiInterfaceMac()

ns3::MeshWifiInterfaceMac::~MeshWifiInterfaceMac ( )

override

D-tor.

Definition at line 76 of file mesh-wifi-interface-mac.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::MeshWifiInterfaceMac::AssignStreams ( int64_t stream )

overridevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

Reimplemented from ns3::WifiMac.

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

References ns3::WifiMac::AssignStreams(), m_coefficient, m_plugins, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ CanForwardPacketsTo()

bool ns3::MeshWifiInterfaceMac::CanForwardPacketsTo ( Mac48Address to ) const

overridevirtual

Return true if packets can be forwarded to the given destination, false otherwise.

Parameters

to	the address to which the packet should be sent

Returns: whether packets can be forwarded to the given destination

Implements ns3::WifiMac.

Definition at line 85 of file mesh-wifi-interface-mac.cc.

◆ CheckSupportedRates()

bool ns3::MeshWifiInterfaceMac::CheckSupportedRates ( AllSupportedRates rates ) const

Check supported rates.

Parameters

rates Rates.

Returns: true if rates are supported

Definition at line 304 of file mesh-wifi-interface-mac.cc.

References ns3::WifiMac::GetDevice(), ns3::GetGuardIntervalForMode(), ns3::WifiMac::GetWifiPhy(), ns3::WifiMac::GetWifiRemoteStationManager(), and ns3::AllSupportedRates::IsSupportedRate().

Here is the call graph for this function:

◆ ConfigureContentionWindow()

void ns3::MeshWifiInterfaceMac::ConfigureContentionWindow	(	uint32_t	cwMin,
		uint32_t	cwMax )

overridevirtual

Parameters

cwMin	the minimum contention window size
cwMax	the maximum contention window size

This method is called to set the minimum and the maximum contention window size.

Reimplemented from ns3::WifiMac.

Definition at line 568 of file mesh-wifi-interface-mac.cc.

References ns3::WifiMac::LinkEntity::channelAccessManager, ns3::WifiMac::ConfigureContentionWindow(), ns3::CreateObjectWithAttributes(), ns3::WifiMac::GetLink(), ns3::WifiMac::m_scheduler, ns3::WifiMac::m_txMiddle, ns3::WifiMac::m_txop, ns3::Txop::SetAifsn(), ns3::Txop::SetMaxCw(), ns3::Txop::SetMinCw(), ns3::Txop::SetTxMiddle(), and ns3::Txop::SetWifiMac().

Here is the call graph for this function:

◆ DoCompleteConfig()

void ns3::MeshWifiInterfaceMac::DoCompleteConfig ( )

overrideprivatevirtual

Allow subclasses to complete the configuration of the MAC layer components.

Implements ns3::WifiMac.

Definition at line 562 of file mesh-wifi-interface-mac.cc.

References ns3::WifiMac::GetQosSupported(), and NS_ABORT_IF.

Here is the call graph for this function:

◆ DoDispose()

void ns3::MeshWifiInterfaceMac::DoDispose ( )

overrideprivatevirtual

Real d-tor.

Reimplemented from ns3::Object.

Definition at line 109 of file mesh-wifi-interface-mac.cc.

References ns3::EventId::Cancel(), ns3::WifiMac::DoDispose(), m_beaconSendEvent, m_plugins, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoInitialize()

void ns3::MeshWifiInterfaceMac::DoInitialize ( )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls 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.

Definition at line 119 of file mesh-wifi-interface-mac.cc.

References ns3::EventId::Cancel(), ns3::Time::GetSeconds(), ns3::EventId::IsPending(), m_beaconEnable, m_beaconSendEvent, m_coefficient, m_randomStart, m_tbtt, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::Seconds(), and SendBeacon().

Here is the call graph for this function:

◆ Enqueue()

void ns3::MeshWifiInterfaceMac::Enqueue	(	Ptr< WifiMpdu >	mpdu,
		Mac48Address	to,
		Mac48Address	from )

overrideprivatevirtual

Parameters

mpdu	the MPDU to send.
to	the address to which the packet should be sent.
from	the address from which the packet should be sent.

Subclasses need to implement this method to finalize the MAC header of the MPDU (MAC addresses and ToDS/FromDS flags) and enqueue the MPDU in a TX queue.

Implements ns3::WifiMac.

Definition at line 201 of file mesh-wifi-interface-mac.cc.

References ns3::Create(), ns3::WifiMac::GetAddress(), ns3::WifiPhy::GetModeList(), ns3::WifiMac::GetQosTxop(), ns3::WifiMac::GetWifiPhy(), ns3::WifiMac::GetWifiRemoteStationManager(), m_plugins, m_stats, NS_ASSERT, NS_LOG_FUNCTION, ns3::Txop::Queue(), ns3::MeshWifiInterfaceMac::Statistics::sentBytes, and ns3::MeshWifiInterfaceMac::Statistics::sentFrames.

Here is the call graph for this function:

◆ GetBeaconGeneration()

bool ns3::MeshWifiInterfaceMac::GetBeaconGeneration ( ) const

private

Get current beaconing status.

Returns: true if beacon active

Definition at line 349 of file mesh-wifi-interface-mac.cc.

References ns3::EventId::IsPending(), and m_beaconSendEvent.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBeaconInterval()

Time ns3::MeshWifiInterfaceMac::GetBeaconInterval ( ) const

Get beacon interval.

Returns: interval between two beacons

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

References m_beaconInterval.

Referenced by Report(), and ScheduleNextBeacon().

Here is the caller graph for this function:

◆ GetFrequencyChannel()

uint16_t ns3::MeshWifiInterfaceMac::GetFrequencyChannel ( ) const

Current channel Id.

Returns: the frequency channel

Definition at line 168 of file mesh-wifi-interface-mac.cc.

References ns3::WifiPhy::GetChannelNumber(), ns3::WifiMac::GetWifiPhy(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by Report().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLinkMetric()

uint32_t ns3::MeshWifiInterfaceMac::GetLinkMetric ( Mac48Address peerAddress )

Get the link metric.

Parameters

peerAddress the peer address

Returns: The metric

Definition at line 479 of file mesh-wifi-interface-mac.cc.

References m_linkMetricCallback.

◆ GetMeshPointAddress()

Mac48Address ns3::MeshWifiInterfaceMac::GetMeshPointAddress ( ) const

Get the mesh point address.

Returns: The mesh point address

Definition at line 503 of file mesh-wifi-interface-mac.cc.

References m_mpAddress.

Referenced by SendBeacon().

Here is the caller graph for this function:

◆ GetSupportedRates()

AllSupportedRates ns3::MeshWifiInterfaceMac::GetSupportedRates ( ) const

Get supported rates.

Returns: list of supported bitrates

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

References ns3::AllSupportedRates::AddSupportedRate(), ns3::WifiMac::GetDevice(), ns3::GetGuardIntervalForMode(), ns3::WifiPhy::GetModeList(), ns3::WifiMac::GetWifiPhy(), ns3::WifiMac::GetWifiRemoteStationManager(), and ns3::AllSupportedRates::SetBasicRate().

Referenced by SendBeacon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTbtt()

Time ns3::MeshWifiInterfaceMac::GetTbtt ( ) const

Next beacon frame time.

Returns: TBTT time

This is supposed to be used by any entity managing beacon collision avoidance (e.g. Peer management protocol in 802.11s)

Definition at line 355 of file mesh-wifi-interface-mac.cc.

References m_tbtt.

Referenced by ShiftTbtt().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MeshWifiInterfaceMac::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 40 of file mesh-wifi-interface-mac.cc.

References GetBeaconGeneration(), m_beaconInterval, m_randomStart, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), SetBeaconGeneration(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ InstallPlugin()

void ns3::MeshWifiInterfaceMac::InstallPlugin ( Ptr< MeshWifiInterfaceMacPlugin > plugin )

Install plugin.

Parameters

plugin Plugin

Todo: return unique ID to allow user to unregister plugins

Definition at line 156 of file mesh-wifi-interface-mac.cc.

References m_plugins, and NS_LOG_FUNCTION.

◆ Receive()

void ns3::MeshWifiInterfaceMac::Receive	(	Ptr< const WifiMpdu >	mpdu,
		uint8_t	linkId )

overrideprivatevirtual

Frame receive handler.

Parameters

mpdu	the received MPDU
linkId	the ID of the link the frame was received over

Reimplemented from ns3::WifiMac.

Definition at line 404 of file mesh-wifi-interface-mac.cc.

Here is the call graph for this function:

◆ Report()

void ns3::MeshWifiInterfaceMac::Report ( std::ostream & os ) const

Report statistics.

Parameters

os	the output stream

Definition at line 540 of file mesh-wifi-interface-mac.cc.

References ns3::WifiMac::GetAddress(), GetBeaconInterval(), GetFrequencyChannel(), ns3::Time::GetSeconds(), m_stats, and ns3::MeshWifiInterfaceMac::Statistics::Print().

Here is the call graph for this function:

◆ ResetStats()

void ns3::MeshWifiInterfaceMac::ResetStats ( )

Reset statistics function.

Definition at line 556 of file mesh-wifi-interface-mac.cc.

References m_stats.

◆ ScheduleNextBeacon()

void ns3::MeshWifiInterfaceMac::ScheduleNextBeacon ( )

private

Schedule next beacon.

Definition at line 374 of file mesh-wifi-interface-mac.cc.

References GetBeaconInterval(), m_beaconSendEvent, m_tbtt, ns3::Simulator::Schedule(), and SendBeacon().

Referenced by SendBeacon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendBeacon()

void ns3::MeshWifiInterfaceMac::SendBeacon ( )

private

Send beacon.

Definition at line 382 of file mesh-wifi-interface-mac.cc.

References ns3::Create(), ns3::MeshWifiBeacon::CreateHeader(), ns3::MeshWifiBeacon::CreatePacket(), ns3::WifiMac::GetAddress(), GetMeshPointAddress(), ns3::Time::GetMicroSeconds(), ns3::WifiMac::GetSsid(), GetSupportedRates(), ns3::EventId::IsPending(), m_beaconInterval, m_beaconSendEvent, m_plugins, ns3::WifiMac::m_txop, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Txop::Queue(), and ScheduleNextBeacon().

Referenced by DoInitialize(), ScheduleNextBeacon(), and ShiftTbtt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendManagementFrame()

void ns3::MeshWifiInterfaceMac::SendManagementFrame	(	Ptr< Packet >	frame,
		const WifiMacHeader &	hdr )

To be used by plugins sending management frames.

Parameters

frame	the management frame
hdr	the wifi MAC header

Definition at line 246 of file mesh-wifi-interface-mac.cc.

References ns3::AC_BK, ns3::AC_VO, ns3::Create(), ns3::WifiMacHeader::GetAddr1(), ns3::Mac48Address::GetBroadcast(), ns3::WifiMac::GetQosTxop(), m_plugins, m_stats, NS_FATAL_ERROR, ns3::Txop::Queue(), ns3::MeshWifiInterfaceMac::Statistics::sentBytes, and ns3::MeshWifiInterfaceMac::Statistics::sentFrames.

Here is the call graph for this function:

◆ SetBeaconGeneration()

void ns3::MeshWifiInterfaceMac::SetBeaconGeneration ( bool enable )

Enable/disable beacons.

Parameters

enable enable / disable flag

Definition at line 342 of file mesh-wifi-interface-mac.cc.

References m_beaconEnable, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetBeaconInterval()

void ns3::MeshWifiInterfaceMac::SetBeaconInterval ( Time interval )

Set interval between two successive beacons.

Parameters

interval beacon interval

Definition at line 329 of file mesh-wifi-interface-mac.cc.

References m_beaconInterval, and NS_LOG_FUNCTION.

◆ SetLinkMetricCallback()

void ns3::MeshWifiInterfaceMac::SetLinkMetricCallback ( Callback< uint32_t, Mac48Address, Ptr< MeshWifiInterfaceMac > > cb )

Set the link metric callback.

Parameters

cb	the callback

Definition at line 490 of file mesh-wifi-interface-mac.cc.

References m_linkMetricCallback.

◆ SetLinkUpCallback()

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

overridevirtual

Parameters

linkUp the callback to invoke when the link becomes up.

Reimplemented from ns3::WifiMac.

Definition at line 97 of file mesh-wifi-interface-mac.cc.

References NS_LOG_FUNCTION, and ns3::WifiMac::SetLinkUpCallback().

Here is the call graph for this function:

◆ SetMeshPointAddress()

void ns3::MeshWifiInterfaceMac::SetMeshPointAddress ( Mac48Address addr )

Set the mesh point address.

Parameters

addr	the mesh point address

Definition at line 497 of file mesh-wifi-interface-mac.cc.

References m_mpAddress.

◆ SetRandomStartDelay()

void ns3::MeshWifiInterfaceMac::SetRandomStartDelay ( Time interval )

Set maximum initial random delay before first beacon.

Parameters

interval maximum random interval

Definition at line 322 of file mesh-wifi-interface-mac.cc.

References m_randomStart, and NS_LOG_FUNCTION.

◆ ShiftTbtt()

void ns3::MeshWifiInterfaceMac::ShiftTbtt ( Time shift )

Shift TBTT.

Parameters

shift Shift

This is supposed to be used by any entity managing beacon collision avoidance (e.g. Peer management protocol in 802.11s)

Attention: User of ShiftTbtt () must take care to not shift it to the past.

Definition at line 361 of file mesh-wifi-interface-mac.cc.

References ns3::Simulator::Cancel(), GetTbtt(), m_beaconSendEvent, m_tbtt, ns3::Simulator::Now(), NS_ASSERT, ns3::Simulator::Schedule(), and SendBeacon().

Here is the call graph for this function:

◆ SupportsSendFrom()

bool ns3::MeshWifiInterfaceMac::SupportsSendFrom ( ) const

overridevirtual

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.

Reimplemented from ns3::WifiMac.

Definition at line 91 of file mesh-wifi-interface-mac.cc.

◆ SwitchFrequencyChannel()

void ns3::MeshWifiInterfaceMac::SwitchFrequencyChannel ( uint16_t new_id )

Switch frequency channel.

Parameters

new_id New ID.

Todo: Correct channel switching is:

Interface down, e.g. to stop packets from layer 3
Wait before all output queues will be empty
Switch PHY channel
Interface up

Now we use dirty channel switch – just change frequency

Definition at line 176 of file mesh-wifi-interface-mac.cc.

References ns3::WifiMac::LinkEntity::channelAccessManager, ns3::WifiMac::GetLink(), ns3::WifiPhy::GetPhyBand(), ns3::WifiMac::GetWifiPhy(), NS_ASSERT, NS_LOG_FUNCTION, ns3::Seconds(), ns3::WifiPhy::SetOperatingChannel(), and ns3::SINGLE_LINK_OP_ID.

Here is the call graph for this function:

Member Data Documentation

◆ m_beaconEnable

bool ns3::MeshWifiInterfaceMac::m_beaconEnable

private

Whether beaconing is enabled

Definition at line 251 of file mesh-wifi-interface-mac.h.

Referenced by DoInitialize(), and SetBeaconGeneration().

◆ m_beaconInterval

Time ns3::MeshWifiInterfaceMac::m_beaconInterval

private

Beaconing interval.

Definition at line 253 of file mesh-wifi-interface-mac.h.

Referenced by GetBeaconInterval(), GetTypeId(), SendBeacon(), and SetBeaconInterval().

◆ m_beaconSendEvent

EventId ns3::MeshWifiInterfaceMac::m_beaconSendEvent

private

"Timer" for the next beacon

Definition at line 264 of file mesh-wifi-interface-mac.h.

Referenced by DoDispose(), DoInitialize(), GetBeaconGeneration(), ScheduleNextBeacon(), SendBeacon(), and ShiftTbtt().

◆ m_coefficient

Ptr<UniformRandomVariable> ns3::MeshWifiInterfaceMac::m_coefficient

private

Add randomness to beacon generation.

Definition at line 293 of file mesh-wifi-interface-mac.h.

Referenced by MeshWifiInterfaceMac(), AssignStreams(), and DoInitialize().

◆ m_linkMetricCallback

Callback<uint32_t, Mac48Address, Ptr<MeshWifiInterfaceMac> > ns3::MeshWifiInterfaceMac::m_linkMetricCallback

private

linkMetricCallback

Definition at line 268 of file mesh-wifi-interface-mac.h.

Referenced by GetLinkMetric(), and SetLinkMetricCallback().

◆ m_mpAddress

Mac48Address ns3::MeshWifiInterfaceMac::m_mpAddress

private

Mesh point address.

Definition at line 261 of file mesh-wifi-interface-mac.h.

Referenced by GetMeshPointAddress(), and SetMeshPointAddress().

◆ m_plugins

PluginList ns3::MeshWifiInterfaceMac::m_plugins

private

List of all installed plugins.

Definition at line 266 of file mesh-wifi-interface-mac.h.

Referenced by AssignStreams(), DoDispose(), Enqueue(), InstallPlugin(), Receive(), SendBeacon(), and SendManagementFrame().

◆ m_randomStart

Time ns3::MeshWifiInterfaceMac::m_randomStart

private

Maximum delay before first beacon.

Definition at line 255 of file mesh-wifi-interface-mac.h.

Referenced by DoInitialize(), GetTypeId(), and SetRandomStartDelay().

◆ m_stats

Statistics ns3::MeshWifiInterfaceMac::m_stats

private

statistics

Definition at line 290 of file mesh-wifi-interface-mac.h.

Referenced by Enqueue(), Receive(), Report(), ResetStats(), and SendManagementFrame().

◆ m_tbtt

Time ns3::MeshWifiInterfaceMac::m_tbtt

private

Time for the next frame.

Definition at line 257 of file mesh-wifi-interface-mac.h.

Referenced by DoInitialize(), GetTbtt(), ScheduleNextBeacon(), and ShiftTbtt().

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

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

Classes

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ PluginList

Constructor & Destructor Documentation

◆ MeshWifiInterfaceMac()

◆ ~MeshWifiInterfaceMac()

Member Function Documentation

◆ AssignStreams()

◆ CanForwardPacketsTo()

◆ CheckSupportedRates()

◆ ConfigureContentionWindow()

◆ DoCompleteConfig()

◆ DoDispose()

◆ DoInitialize()

◆ Enqueue()

◆ GetBeaconGeneration()

◆ GetBeaconInterval()

◆ GetFrequencyChannel()

◆ GetLinkMetric()

◆ GetMeshPointAddress()

◆ GetSupportedRates()

◆ GetTbtt()

◆ GetTypeId()

◆ InstallPlugin()

◆ Receive()

◆ Report()

◆ ResetStats()

◆ ScheduleNextBeacon()

◆ SendBeacon()

◆ SendManagementFrame()

◆ SetBeaconGeneration()

◆ SetBeaconInterval()

◆ SetLinkMetricCallback()

◆ SetLinkUpCallback()

◆ SetMeshPointAddress()

◆ SetRandomStartDelay()

◆ ShiftTbtt()

◆ SupportsSendFrom()

◆ SwitchFrequencyChannel()

Member Data Documentation

◆ m_beaconEnable

◆ m_beaconInterval

◆ m_beaconSendEvent

◆ m_coefficient

◆ m_linkMetricCallback

◆ m_mpAddress

◆ m_plugins

◆ m_randomStart

◆ m_stats

◆ m_tbtt