Hold together all Wifi-related objects. More...

#include "wifi-net-device.h"

Inheritance diagram for ns3::WifiNetDevice:

Collaboration diagram for ns3::WifiNetDevice:

Public Member Functions
	WifiNetDevice ()

	WifiNetDevice (const WifiNetDevice &o)=delete

	~WifiNetDevice () override

void	AddLinkChangeCallback (Callback< void > callback) override

Address	GetAddress () const override

Address	GetBroadcast () const override

Ptr< Channel >	GetChannel () const override

Ptr< EhtConfiguration >	GetEhtConfiguration () const

Ptr< HeConfiguration >	GetHeConfiguration () const

Ptr< HtConfiguration >	GetHtConfiguration () const

uint32_t	GetIfIndex () const override

Ptr< WifiMac >	GetMac () const

uint16_t	GetMtu () const override

Address	GetMulticast (Ipv4Address multicastGroup) const override
	Make and return a MAC multicast address using the provided multicast group. More...

Address	GetMulticast (Ipv6Address addr) const override
	Get the MAC multicast address corresponding to the IPv6 address provided. More...

Ptr< Node >	GetNode () const override

uint8_t	GetNPhys () const

uint8_t	GetNRemoteStationManagers () const

Ptr< WifiPhy >	GetPhy () const

virtual Ptr< WifiPhy >	GetPhy (uint8_t i) const

virtual const std::vector< Ptr< WifiPhy > > &	GetPhys () const

Ptr< WifiRemoteStationManager >	GetRemoteStationManager () const

Ptr< WifiRemoteStationManager >	GetRemoteStationManager (uint8_t linkId) const

virtual const std::vector< Ptr< WifiRemoteStationManager > > &	GetRemoteStationManagers () const

WifiStandard	GetStandard () const
	Get the Wifi standard. More...

Ptr< VhtConfiguration >	GetVhtConfiguration () const

bool	IsBridge () const override
	Return true if the net device is acting as a bridge. More...

bool	IsBroadcast () const override

bool	IsLinkUp () const override

bool	IsMulticast () const override

bool	IsPointToPoint () const override
	Return true if the net device is on a point-to-point link. More...

bool	NeedsArp () const override

WifiNetDevice &	operator= (const WifiNetDevice &)=delete

bool	Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override

bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) override

void	SetAddress (Address address) override
	Set the address of this interface. More...

void	SetEhtConfiguration (Ptr< EhtConfiguration > ehtConfiguration)

void	SetHeConfiguration (Ptr< HeConfiguration > heConfiguration)

void	SetHtConfiguration (Ptr< HtConfiguration > htConfiguration)

void	SetIfIndex (const uint32_t index) override

void	SetMac (const Ptr< WifiMac > mac)

bool	SetMtu (const uint16_t mtu) override

void	SetNode (const Ptr< Node > node) override

void	SetPhy (const Ptr< WifiPhy > phy)

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

void	SetPromiscReceiveCallback (PromiscReceiveCallback cb) override

void	SetReceiveCallback (NetDevice::ReceiveCallback cb) override

void	SetRemoteStationManager (const Ptr< WifiRemoteStationManager > manager)

void	SetRemoteStationManagers (const std::vector< Ptr< WifiRemoteStationManager >> &managers)

void	SetStandard (WifiStandard standard)
	Set the Wifi standard. More...

void	SetVhtConfiguration (Ptr< VhtConfiguration > vhtConfiguration)

bool	SupportsSendFrom () const override

Public Member Functions inherited from ns3::NetDevice
	~NetDevice () override

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

	~Object () override
	Destructor. More...

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

void	Dispose ()
	Dispose of this Object. More...

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

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

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

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

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

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

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

bool	IsInitialized () 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[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () 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 errors. 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 ()
	Get the type ID. More...

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

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

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

Protected Member Functions
void	DoDispose () override
	Destructor implementation. More...

void	DoInitialize () override
	Initialize() implementation. More...

void	ForwardUp (Ptr< const Packet > packet, Mac48Address from, Mac48Address to)
	Receive a packet from the lower layer and pass the packet up the stack. More...

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

virtual void	NotifyNewAggregate ()
	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 ()
	Notifier called once the ObjectBase is fully constructed. More...

Private Member Functions
void	CompleteConfig ()
	Complete the configuration of this Wi-Fi device by connecting all lower components (e.g. More...

void	LinkDown ()
	Set that the link is down (i.e. More...

void	LinkUp ()
	Set that the link is up. More...

Private Attributes
bool	m_configComplete
	configuration complete More...

Ptr< EhtConfiguration >	m_ehtConfiguration
	the EhtConfiguration More...

NetDevice::ReceiveCallback	m_forwardUp
	forward up callback More...

Ptr< HeConfiguration >	m_heConfiguration
	the HeConfiguration More...

Ptr< HtConfiguration >	m_htConfiguration
	the HtConfiguration More...

uint32_t	m_ifIndex
	IF index. More...

TracedCallback	m_linkChanges
	link change callback More...

bool	m_linkUp
	link up More...

Ptr< WifiMac >	m_mac
	the MAC More...

uint16_t	m_mtu
	MTU. More...

Ptr< Node >	m_node
	the node More...

std::vector< Ptr< WifiPhy > >	m_phys
	the phy objects More...

NetDevice::PromiscReceiveCallback	m_promiscRx
	promiscuous receive callback More...

TracedCallback< Ptr< const Packet >, Mac48Address >	m_rxLogger
	receive trace callback More...

WifiStandard	m_standard
	Wifi standard. More...

std::vector< Ptr< WifiRemoteStationManager > >	m_stationManagers
	the station managers More...

TracedCallback< Ptr< const Packet >, Mac48Address >	m_txLogger
	transmit trace callback More...

Ptr< VhtConfiguration >	m_vhtConfiguration
	the VhtConfiguration More...

Additional Inherited Members
Public Types inherited from ns3::NetDevice
typedef void(*	LinkChangeTracedCallback) ()
	TracedCallback signature for link changed event. More...

enum	PacketType { PACKET_HOST = 1 , NS3_PACKET_HOST = PACKET_HOST , PACKET_BROADCAST , NS3_PACKET_BROADCAST = PACKET_BROADCAST , PACKET_MULTICAST , NS3_PACKET_MULTICAST = PACKET_MULTICAST , PACKET_OTHERHOST , NS3_PACKET_OTHERHOST = PACKET_OTHERHOST }
	Packet types are used as they are in Linux. More...

typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, PacketType >	PromiscReceiveCallback

typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address & >	ReceiveCallback

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

Detailed Description

Hold together all Wifi-related objects.

This class holds together ns3::Channel, ns3::WifiPhy, ns3::WifiMac, and, ns3::WifiRemoteStationManager.

Definition at line 58 of file wifi-net-device.h.

Constructor & Destructor Documentation

◆ WifiNetDevice() [1/2]

ns3::WifiNetDevice::WifiNetDevice ( )

Definition at line 122 of file wifi-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~WifiNetDevice()

ns3::WifiNetDevice::~WifiNetDevice ( )

override

Definition at line 129 of file wifi-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ WifiNetDevice() [2/2]

ns3::WifiNetDevice::WifiNetDevice ( const WifiNetDevice & o )

delete

Member Function Documentation

◆ AddLinkChangeCallback()

void ns3::WifiNetDevice::AddLinkChangeCallback ( Callback< void > callback )

overridevirtual

Parameters

callback the callback to invoke

Add a callback invoked whenever the link status changes to UP. This callback is typically used by the IP/ARP layer to flush the ARP cache and by IPv6 stack to flush NDISC cache whenever the link goes up.

Implements ns3::NetDevice.

Definition at line 430 of file wifi-net-device.cc.

References ns3::TracedCallback< Ts >::ConnectWithoutContext(), and m_linkChanges.

Here is the call graph for this function:

◆ CompleteConfig()

void ns3::WifiNetDevice::CompleteConfig ( )

private

Complete the configuration of this Wi-Fi device by connecting all lower components (e.g.

MAC, WifiRemoteStation) together.

Definition at line 212 of file wifi-net-device.cc.

References ForwardUp(), LinkDown(), LinkUp(), m_configComplete, m_mac, m_node, m_phys, m_stationManagers, ns3::MakeCallback(), NS_ABORT_IF, ns3::WifiMac::SetForwardUpCallback(), ns3::WifiMac::SetLinkDownCallback(), ns3::WifiMac::SetLinkUpCallback(), ns3::WifiMac::SetWifiPhys(), and ns3::WifiMac::SetWifiRemoteStationManagers().

Referenced by SetMac(), SetNode(), SetPhy(), SetPhys(), SetRemoteStationManager(), and SetRemoteStationManagers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::WifiNetDevice::DoDispose ( void )

overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 135 of file wifi-net-device.cc.

References ns3::Object::Dispose(), ns3::Object::DoDispose(), m_ehtConfiguration, m_heConfiguration, m_htConfiguration, m_mac, m_node, m_phys, m_stationManagers, m_vhtConfiguration, NS_LOG_FUNCTION_NOARGS, and third::phy.

Here is the call graph for this function:

◆ DoInitialize()

void ns3::WifiNetDevice::DoInitialize ( void )

overrideprotectedvirtual

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 186 of file wifi-net-device.cc.

References ns3::Object::DoInitialize(), ns3::Object::Initialize(), m_mac, m_phys, m_stationManagers, NS_LOG_FUNCTION_NOARGS, and third::phy.

Here is the call graph for this function:

◆ ForwardUp()

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

protected

Receive a packet from the lower layer and pass the packet up the stack.

Parameters

packet	the packet to forward up
from	the source address
to	the destination address

Definition at line 520 of file wifi-net-device.cc.

References ns3::Packet::Copy(), GetAddress(), ns3::LlcSnapHeader::GetType(), ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsGroup(), ns3::Callback< R, UArgs >::IsNull(), m_forwardUp, m_mac, m_promiscRx, ns3::WifiMac::NotifyPromiscRx(), ns3::WifiMac::NotifyRx(), NS_LOG_FUNCTION, ns3::NetDevice::PACKET_BROADCAST, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, ns3::NetDevice::PACKET_OTHERHOST, ns3::Packet::RemoveHeader(), and check-style-clang-format::type.

Referenced by CompleteConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAddress()

Address ns3::WifiNetDevice::GetAddress ( ) const

overridevirtual

Returns: the current Address of this interface.

Normally, the MAC address that the network device has to advertise to upper layers is the MLD address, if this device is an MLD, or the unique MAC address, otherwise. Advertising the MAC address returned by WifiMac::GetAddress() is therefore the right thing to do in both cases. However, there is an exception: if this device is a non-AP MLD associated with a single link AP (hence, no ML setup was done), we need to advertise the MAC address of the link used to communicate with the AP. In fact, if we advertised the MLD address, the AP could not forward a frame to us because it would not recognize our MLD address as the MAC address of an associated station.

Implements ns3::NetDevice.

Definition at line 377 of file wifi-net-device.cc.

References ns3::WifiMac::GetAddress(), ns3::WifiMac::GetBssid(), ns3::WifiMac::GetFrameExchangeManager(), ns3::WifiMac::GetNLinks(), ns3::StaWifiMac::GetSetupLinkIds(), ns3::WifiMac::GetTypeOfStation(), ns3::WifiMac::GetWifiRemoteStationManager(), m_mac, and ns3::STA.

Referenced by OfdmaAckSequenceTest::CheckResults(), ContextToMac(), BlockAckAggregationDisabledTest::DoRun(), PreservePacketsInAmpdus::DoRun(), OfdmaAckSequenceTest::DoRun(), Bug730TestCase::DoRun(), QosFragmentationTestCase::DoRun(), Bug2222TestCase::DoRun(), EmlsrOperationsTestBase::DoSetup(), ForwardUp(), TestUlOfdmaPowerControl::ReceiveOkCallbackAtAp(), TestUlOfdmaPowerControl::RunOne(), TestUlOfdmaPowerControl::SendMuBar(), TestInterBssConstantObssPdAlgo::SendOnePacket(), MultiLinkSetupTest::StartTraffic(), MultiLinkTxTest::StartTraffic(), MultiLinkMuTxTest::StartTraffic(), and OfdmaAckSequenceTest::Transmit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBroadcast()

Address ns3::WifiNetDevice::GetBroadcast ( ) const

overridevirtual

Returns: the broadcast address supported by this netdevice.

Calling this method is invalid if IsBroadcast returns not true.

Implements ns3::NetDevice.

Definition at line 442 of file wifi-net-device.cc.

References ns3::Mac48Address::GetBroadcast().

Referenced by WifiTest::SendOnePacket(), InterferenceHelperSequenceTest::SendOnePacket(), and DcfImmediateAccessBroadcastTestCase::SendOnePacket().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChannel()

Ptr< Channel > ns3::WifiNetDevice::GetChannel ( ) const

overridevirtual

Returns: the channel this NetDevice is connected to. The value returned can be zero if the NetDevice is not yet connected to any channel or if the underlying NetDevice has no concept of a channel. i.e., callers must check for zero and be ready to handle it.

Implements ns3::NetDevice.

Definition at line 357 of file wifi-net-device.cc.

References ns3::WifiPhy::GetChannel(), GetNPhys(), GetPhy(), m_phys, NS_ABORT_MSG, and ns3::SINGLE_LINK_OP_ID.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetEhtConfiguration()

Ptr< EhtConfiguration > ns3::WifiNetDevice::GetEhtConfiguration ( ) const

Returns: pointer to EhtConfiguration if it exists

Definition at line 654 of file wifi-net-device.cc.

References m_ehtConfiguration, m_standard, and ns3::WIFI_STANDARD_80211be.

Referenced by ns3::WifiMacHelper::Create(), ns3::WifiMac::GetEhtConfiguration(), ns3::WifiRemoteStationManager::GetEhtSupported(), and GetTypeId().

Here is the caller graph for this function:

◆ GetHeConfiguration()

Ptr< HeConfiguration > ns3::WifiNetDevice::GetHeConfiguration ( ) const

Returns: pointer to HeConfiguration if it exists

Definition at line 642 of file wifi-net-device.cc.

References m_heConfiguration, m_standard, and ns3::WIFI_STANDARD_80211ax.

Referenced by ns3::ConvertGuardIntervalToNanoSeconds(), TestUlOfdmaPowerControl::DoSetup(), ns3::HePhy::GetBssColor(), ns3::WifiRemoteStationManager::GetDataTxVector(), ns3::WifiRemoteStationManager::GetGuardInterval(), ns3::WifiMac::GetHeConfiguration(), ns3::WifiRemoteStationManager::GetHeSupported(), ns3::HePhy::GetMaxDelayPpduSameUid(), GetTypeId(), ns3::ConstantObssPdAlgorithm::ReceiveHeSigA(), ns3::ObssPdAlgorithm::ResetPhy(), TestInterBssConstantObssPdAlgo::RunOne(), TestUlMuMimoPhyTransmission::SetBssColor(), and TestUlOfdmaPhyTransmission::SetBssColor().

Here is the caller graph for this function:

◆ GetHtConfiguration()

Ptr< HtConfiguration > ns3::WifiNetDevice::GetHtConfiguration ( ) const

Returns: pointer to HtConfiguration if it exists

Definition at line 618 of file wifi-net-device.cc.

References m_htConfiguration, m_standard, and ns3::WIFI_STANDARD_80211n.

Referenced by ns3::ConvertGuardIntervalToNanoSeconds(), ns3::WifiPhy::DoChannelSwitch(), ns3::WifiMac::GetHtConfiguration(), ns3::WifiRemoteStationManager::GetHtSupported(), ns3::WifiRemoteStationManager::GetLdpcSupported(), ns3::WifiRemoteStationManager::GetShortGuardIntervalSupported(), and GetTypeId().

Here is the caller graph for this function:

◆ GetIfIndex()

uint32_t ns3::WifiNetDevice::GetIfIndex ( ) const

overridevirtual

Returns: index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 351 of file wifi-net-device.cc.

References m_ifIndex.

Referenced by BlockAckAggregationDisabledTest::DoRun(), PreservePacketsInAmpdus::DoRun(), OfdmaAckSequenceTest::DoRun(), Bug730TestCase::DoRun(), QosFragmentationTestCase::DoRun(), Bug2222TestCase::DoRun(), EmlsrOperationsTestBase::DoSetup(), ns3::dot11s::HwmpProtocol::Install(), ns3::flame::FlameProtocol::Install(), MultiLinkSetupTest::StartTraffic(), MultiLinkTxTest::StartTraffic(), MultiLinkMuTxTest::StartTraffic(), and ReleaseSeqNoAfterCtsTimeoutTest::StartTraffic().

Here is the caller graph for this function:

◆ GetMac()

Ptr< WifiMac > ns3::WifiNetDevice::GetMac ( ) const

Returns: the MAC we are currently using.

Definition at line 289 of file wifi-net-device.cc.

References m_mac.

Referenced by NodeStatistics::NodeStatistics(), ns3::MeshPointDevice::AddInterface(), ns3::HePhy::CanStartRx(), BlockAckAggregationDisabledTest::DoRun(), PreservePacketsInAmpdus::DoRun(), OfdmaAckSequenceTest::DoRun(), TestUnsupportedModulationReception::DoRun(), WifiPrimaryChannelsTest::DoRun(), QosFragmentationTestCase::DoRun(), WifiTxopTest::DoRun(), ns3::HePhy::DoStartReceivePayload(), ns3::AnimationInterface::GenericWirelessTxTrace(), ns3::HePhy::GetStaId(), GetTypeId(), ns3::dot11s::HwmpProtocol::Install(), ns3::dot11s::PeerManagementProtocol::Install(), ns3::flame::FlameProtocol::Install(), ns3::ConstantObssPdAlgorithm::ReceiveHeSigA(), ns3::Dot11sStack::Report(), ns3::Dot11sStack::ResetStats(), Experiment::Run(), TestUlOfdmaPowerControl::RunOne(), Issue40TestCase::RunOne(), TestUlOfdmaPowerControl::SendMuBar(), ns3::HePhy::SetTrigVector(), ns3::HePhy::StartTx(), OfdmaAckSequenceTest::Transmit(), StaWifiMacScanningTestCase::TurnBeaconGenerationOn(), and ns3::AnimationInterface::WifiPhyTxBeginTrace().

Here is the caller graph for this function:

◆ GetMtu()

uint16_t ns3::WifiNetDevice::GetMtu ( ) const

overridevirtual

Returns: the link-level MTU in bytes for this interface.

This value is typically used by the IP layer to perform IP fragmentation when needed.

Implements ns3::NetDevice.

Definition at line 418 of file wifi-net-device.cc.

References m_mtu.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetMulticast() [1/2]

Address ns3::WifiNetDevice::GetMulticast ( Ipv4Address multicastGroup ) const

overridevirtual

Make and return a MAC multicast address using the provided multicast group.

RFC 1112 says that an Ipv4 host group address is mapped to an Ethernet multicast address by placing the low-order 23-bits of the IP address into the low-order 23 bits of the Ethernet multicast address 01-00-5E-00-00-00 (hex). Similar RFCs exist for Ipv6 and Eui64 mappings. This method performs the multicast address creation function appropriate to the underlying MAC address of the device. This MAC address is encapsulated in an abstract Address to avoid dependencies on the exact MAC address format.

In the case of net devices that do not support multicast, clients are expected to test NetDevice::IsMulticast and avoid attempting to map multicast packets. Subclasses of NetDevice that do support multicasting are expected to override this method and provide an implementation appropriate to the particular device.

Parameters

multicastGroup The IP address for the multicast group destination of the packet.

Returns: The MAC multicast Address used to send packets to the provided multicast group.

Warning: Calling this method is invalid if IsMulticast returns not true.

See also: IsMulticast()

Implements ns3::NetDevice.

Definition at line 454 of file wifi-net-device.cc.

References ns3::Mac48Address::GetMulticast().

Here is the call graph for this function:

◆ GetMulticast() [2/2]

Address ns3::WifiNetDevice::GetMulticast ( Ipv6Address addr ) const

overridevirtual

Get the MAC multicast address corresponding to the IPv6 address provided.

Parameters

addr	IPv6 address

Returns: the MAC multicast address

Warning: Calling this method is invalid if IsMulticast returns not true.

Implements ns3::NetDevice.

Definition at line 460 of file wifi-net-device.cc.

References ns3::Mac48Address::GetMulticast().

Here is the call graph for this function:

◆ GetNode()

Ptr< Node > ns3::WifiNetDevice::GetNode ( ) const

overridevirtual

Returns: the node base class which contains this network interface.

When a subclass needs to get access to the underlying node base class to print the nodeid for example, it can invoke this method.

Implements ns3::NetDevice.

Definition at line 495 of file wifi-net-device.cc.

References m_node.

Referenced by TestInterBssConstantObssPdAlgo::CheckPhyDropReasons(), EmlsrDlTxopTest::CheckQosFrames(), EmlsrLinkSwitchTest::CheckQosFrames(), ns3::WifiPhy::DoInitialize(), MultiLinkSetupTest::DoRun(), ns3::AnimationInterface::GenericWirelessTxTrace(), EmlsrDlTxopTest::StartTraffic(), MultiLinkSetupTest::StartTraffic(), MultiLinkTxTest::StartTraffic(), MultiLinkMuTxTest::StartTraffic(), ReleaseSeqNoAfterCtsTimeoutTest::StartTraffic(), ReleaseSeqNoAfterCtsTimeoutTest::Transmit(), and ns3::AnimationInterface::WifiPhyTxBeginTrace().

Here is the caller graph for this function:

◆ GetNPhys()

uint8_t ns3::WifiNetDevice::GetNPhys ( ) const

Returns: the number of PHY objects

Definition at line 314 of file wifi-net-device.cc.

References GetPhys().

Referenced by ns3::WifiMacHelper::Create(), ns3::WifiPhyHelper::EnableAsciiInternal(), ns3::WifiPhyHelper::EnablePcapInternal(), GetChannel(), and GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNRemoteStationManagers()

uint8_t ns3::WifiNetDevice::GetNRemoteStationManagers ( ) const

Returns: the number of remote station managers

Definition at line 339 of file wifi-net-device.cc.

References GetRemoteStationManagers().

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPhy() [1/2]

Ptr< WifiPhy > ns3::WifiNetDevice::GetPhy ( ) const

Returns: the PHY we are currently using.

This GetPhy variant is needed to keep using "Phy" in the path names.

Definition at line 295 of file wifi-net-device.cc.

References ns3::SINGLE_LINK_OP_ID.

Referenced by NodeStatistics::NodeStatistics(), TestInterBssConstantObssPdAlgo::CheckPhyState(), ns3::ObssPdAlgorithm::ConnectWifiNetDevice(), ns3::ConstantObssPdAlgorithm::ConnectWifiNetDevice(), ns3::WifiRadioEnergyModelHelper::DoInstall(), ns3::DefaultEmlsrManager::DoNotifyTxopEnd(), PreservePacketsInAmpdus::DoRun(), WifiPrimaryChannelsTest::DoRun(), TestUlOfdmaPowerControl::DoSetup(), GetChannel(), ns3::WifiMac::GetLinkForPhy(), GetTypeId(), GetYansWifiPhyPtr(), SetChannelFrequencyTest::GetYansWifiPhyPtr(), ns3::EmlsrManager::NotifyIcfReceived(), ns3::EmlsrManager::NotifyUlTxopStart(), ns3::ObssPdAlgorithm::ResetPhy(), TestUlOfdmaPowerControl::RunOne(), TestUlOfdmaPowerControl::SendMuBar(), ns3::EhtFrameExchangeManager::StartTransmission(), InterferenceHelperSequenceTest::SwitchCh(), PowerRateAdaptationTest::TestAparf(), PowerRateAdaptationTest::TestParf(), PowerRateAdaptationTest::TestRrpaa(), and StaWifiMacScanningTestCase::TurnApOff().

Here is the caller graph for this function:

◆ GetPhy() [2/2]

Ptr< WifiPhy > ns3::WifiNetDevice::GetPhy ( uint8_t i ) const

virtual

Parameters

i	the index (starting at 0) of the PHY object to retrieve

Returns: the requested PHY object

Definition at line 301 of file wifi-net-device.cc.

References GetPhys(), and NS_ASSERT.

Here is the call graph for this function:

◆ GetPhys()

const std::vector< Ptr< WifiPhy > > & ns3::WifiNetDevice::GetPhys ( ) const

virtual

Returns: a const reference to the vector of PHY objects

Definition at line 308 of file wifi-net-device.cc.

References m_phys.

Referenced by ns3::WifiPhyHelper::EnablePcapInternal(), GetNPhys(), and GetPhy().

Here is the caller graph for this function:

◆ GetRemoteStationManager() [1/2]

Ptr< WifiRemoteStationManager > ns3::WifiNetDevice::GetRemoteStationManager ( ) const

Returns: the remote station manager we are currently using.

This GetRemoteStationManager variant is needed to keep using "RemoteStationManager" in the path names.

Definition at line 320 of file wifi-net-device.cc.

Referenced by GetTypeId(), PowerRateAdaptationTest::TestAparf(), PowerRateAdaptationTest::TestParf(), and PowerRateAdaptationTest::TestRrpaa().

Here is the caller graph for this function:

◆ GetRemoteStationManager() [2/2]

Ptr< WifiRemoteStationManager > ns3::WifiNetDevice::GetRemoteStationManager ( uint8_t linkId ) const

Parameters

linkId the ID (starting at 0) of the link of the RemoteStationManager object to retrieve

Returns: the requested remote station manager

Definition at line 326 of file wifi-net-device.cc.

References GetRemoteStationManagers(), and NS_ASSERT.

Here is the call graph for this function:

◆ GetRemoteStationManagers()

const std::vector< Ptr< WifiRemoteStationManager > > & ns3::WifiNetDevice::GetRemoteStationManagers ( ) const

virtual

Returns: a const reference to the vector of remote station managers

Definition at line 333 of file wifi-net-device.cc.

References m_stationManagers.

Referenced by GetNRemoteStationManagers(), and GetRemoteStationManager().

Here is the caller graph for this function:

◆ GetStandard()

WifiStandard ns3::WifiNetDevice::GetStandard ( ) const

Get the Wifi standard.

Returns: the Wifi standard

Definition at line 240 of file wifi-net-device.cc.

References m_standard.

◆ GetTypeId()

TypeId ns3::WifiNetDevice::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 46 of file wifi-net-device.cc.

References ns3::TypeId::DEPRECATED, GetChannel(), GetEhtConfiguration(), GetHeConfiguration(), GetHtConfiguration(), GetMac(), GetMtu(), GetNPhys(), GetNRemoteStationManagers(), GetPhy(), GetRemoteStationManager(), GetVhtConfiguration(), ns3::LLC_SNAP_HEADER_LENGTH, ns3::MakeObjectVectorAccessor(), ns3::MakePointerAccessor(), ns3::MakeUintegerAccessor(), ns3::MAX_MSDU_SIZE, SetMac(), SetMtu(), ns3::TypeId::SetParent(), SetPhy(), and SetRemoteStationManager().

Here is the call graph for this function:

◆ GetVhtConfiguration()

Ptr< VhtConfiguration > ns3::WifiNetDevice::GetVhtConfiguration ( ) const

Returns: pointer to VhtConfiguration if it exists

Definition at line 630 of file wifi-net-device.cc.

References m_standard, m_vhtConfiguration, and ns3::WIFI_STANDARD_80211ac.

Referenced by ns3::WifiPhy::DoChannelSwitch(), ns3::VhtPhy::GetCcaThreshold(), GetTypeId(), ns3::WifiMac::GetVhtConfiguration(), and ns3::WifiRemoteStationManager::GetVhtSupported().

Here is the caller graph for this function:

◆ IsBridge()

bool ns3::WifiNetDevice::IsBridge ( ) const

overridevirtual

Return true if the net device is acting as a bridge.

Returns: value of m_isBridge flag

Implements ns3::NetDevice.

Definition at line 472 of file wifi-net-device.cc.

◆ IsBroadcast()

bool ns3::WifiNetDevice::IsBroadcast ( ) const

overridevirtual

Returns: true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

Definition at line 436 of file wifi-net-device.cc.

◆ IsLinkUp()

bool ns3::WifiNetDevice::IsLinkUp ( ) const

overridevirtual

Returns: true if link is up; false otherwise

Implements ns3::NetDevice.

Definition at line 424 of file wifi-net-device.cc.

References m_linkUp, and m_phys.

◆ IsMulticast()

bool ns3::WifiNetDevice::IsMulticast ( ) const

overridevirtual

Returns: value of m_isMulticast flag

Implements ns3::NetDevice.

Definition at line 448 of file wifi-net-device.cc.

◆ IsPointToPoint()

bool ns3::WifiNetDevice::IsPointToPoint ( ) const

overridevirtual

Return true if the net device is on a point-to-point link.

Returns: value of m_isPointToPoint flag

Implements ns3::NetDevice.

Definition at line 466 of file wifi-net-device.cc.

◆ LinkDown()

void ns3::WifiNetDevice::LinkDown ( )

private

Set that the link is down (i.e.

STA is not associated).

Definition at line 569 of file wifi-net-device.cc.

References m_linkChanges, and m_linkUp.

Referenced by CompleteConfig().

Here is the caller graph for this function:

◆ LinkUp()

void ns3::WifiNetDevice::LinkUp ( )

private

Set that the link is up.

A link is always up in ad-hoc mode. For a STA, a link is up when the STA is associated with an AP.

Definition at line 562 of file wifi-net-device.cc.

References m_linkChanges, and m_linkUp.

Referenced by CompleteConfig().

Here is the caller graph for this function:

◆ NeedsArp()

bool ns3::WifiNetDevice::NeedsArp ( ) const

overridevirtual

Returns: true if ARP is needed, false otherwise.

Called by higher-layers to check if this NetDevice requires ARP to be used.

Implements ns3::NetDevice.

Definition at line 508 of file wifi-net-device.cc.

◆ operator=()

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

delete

◆ Send()

bool ns3::WifiNetDevice::Send	(	Ptr< Packet >	packet,
		const Address &	dest,
		uint16_t	protocolNumber
	)

overridevirtual

Parameters

packet	packet sent from above down to Network Device
dest	mac address of the destination (already resolved)
protocolNumber	identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

Called from higher layer to send packet into Network Device to the specified destination Address

Returns: whether the Send operation succeeded

Implements ns3::NetDevice.

Definition at line 478 of file wifi-net-device.cc.

References ns3::Packet::AddHeader(), ns3::Mac48Address::ConvertFrom(), ns3::WifiMac::Enqueue(), ns3::Mac48Address::IsMatchingType(), m_mac, ns3::WifiMac::NotifyTx(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::LlcSnapHeader::SetType().

Referenced by WifiTest::SendOnePacket(), InterferenceHelperSequenceTest::SendOnePacket(), DcfImmediateAccessBroadcastTestCase::SendOnePacket(), TestInterBssConstantObssPdAlgo::SendOnePacket(), TestUlOfdmaPowerControl::SetupBa(), PowerRateAdaptationTest::TestAparf(), PowerRateAdaptationTest::TestParf(), and PowerRateAdaptationTest::TestRrpaa().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SendFrom()

bool ns3::WifiNetDevice::SendFrom	(	Ptr< Packet >	packet,
		const Address &	source,
		const Address &	dest,
		uint16_t	protocolNumber
	)

overridevirtual

Parameters

packet	packet sent from above down to Network Device
source	source mac address (so called "MAC spoofing")
dest	mac address of the destination (already resolved)
protocolNumber	identifies the type of payload contained in this packet. Used to call the right L3Protocol when the packet is received.

Called from higher layer to send packet into Network Device with the specified source and destination Addresses.

Returns: whether the Send operation succeeded

Implements ns3::NetDevice.

Definition at line 576 of file wifi-net-device.cc.

References ns3::Packet::AddHeader(), ns3::Mac48Address::ConvertFrom(), ns3::WifiMac::Enqueue(), ns3::Mac48Address::IsMatchingType(), m_mac, ns3::WifiMac::NotifyTx(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::LlcSnapHeader::SetType().

Here is the call graph for this function:

◆ SetAddress()

void ns3::WifiNetDevice::SetAddress ( Address address )

overridevirtual

Set the address of this interface.

Parameters

address address to set

Implements ns3::NetDevice.

Definition at line 371 of file wifi-net-device.cc.

References first::address, ns3::Mac48Address::ConvertFrom(), m_mac, and ns3::WifiMac::SetAddress().

Here is the call graph for this function:

◆ SetEhtConfiguration()

void ns3::WifiNetDevice::SetEhtConfiguration ( Ptr< EhtConfiguration > ehtConfiguration )

Parameters

ehtConfiguration pointer to EhtConfiguration

Definition at line 648 of file wifi-net-device.cc.

References m_ehtConfiguration.

Referenced by AmpduAggregationTest::DoSetup(), and ns3::WifiHelper::Install().

Here is the caller graph for this function:

◆ SetHeConfiguration()

void ns3::WifiNetDevice::SetHeConfiguration ( Ptr< HeConfiguration > heConfiguration )

Parameters

heConfiguration pointer to HeConfiguration

Definition at line 636 of file wifi-net-device.cc.

References m_heConfiguration.

Referenced by AmpduAggregationTest::DoSetup(), TestUlMuMimoPhyTransmission::DoSetup(), TestUlOfdmaPpduUid::DoSetup(), TestMultipleHeTbPreambles::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), TestPhyPaddingExclusion::DoSetup(), and ns3::WifiHelper::Install().

Here is the caller graph for this function:

◆ SetHtConfiguration()

void ns3::WifiNetDevice::SetHtConfiguration ( Ptr< HtConfiguration > htConfiguration )

Parameters

htConfiguration pointer to HtConfiguration

Definition at line 612 of file wifi-net-device.cc.

References m_htConfiguration.

Referenced by Bug2831TestCase::DoRun(), AmpduAggregationTest::DoSetup(), and ns3::WifiHelper::Install().

Here is the caller graph for this function:

◆ SetIfIndex()

void ns3::WifiNetDevice::SetIfIndex ( const uint32_t index )

overridevirtual

Parameters

index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 345 of file wifi-net-device.cc.

References m_ifIndex.

◆ SetMac()

void ns3::WifiNetDevice::SetMac ( const Ptr< WifiMac > mac )

Parameters

mac	the MAC layer to use.

Definition at line 246 of file wifi-net-device.cc.

References CompleteConfig(), m_mac, and third::mac.

Referenced by PowerRateAdaptationTest::ConfigureNode(), ns3::WifiMacHelper::Create(), ns3::MeshHelper::CreateInterface(), WifiTest::CreateOne(), InterferenceHelperSequenceTest::CreateOne(), DcfImmediateAccessBroadcastTestCase::DoRun(), Bug2831TestCase::DoRun(), AmpduAggregationTest::DoSetup(), TestUlMuMimoPhyTransmission::DoSetup(), TestMultipleHeTbPreambles::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), TestPhyPaddingExclusion::DoSetup(), and GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetMtu()

bool ns3::WifiNetDevice::SetMtu ( const uint16_t mtu )

overridevirtual

Parameters

mtu	MTU value, in bytes, to set for the device

Returns: whether the MTU value was within legal bounds

Override for default MTU defined on a per-type basis.

Implements ns3::NetDevice.

Definition at line 407 of file wifi-net-device.cc.

References ns3::LLC_SNAP_HEADER_LENGTH, m_mtu, and ns3::MAX_MSDU_SIZE.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetNode()

void ns3::WifiNetDevice::SetNode ( const Ptr< Node > node )

overridevirtual

Parameters

node	the node associated to this netdevice.

This method is called from ns3::Node::AddDevice.

Implements ns3::NetDevice.

Definition at line 501 of file wifi-net-device.cc.

References CompleteConfig(), and m_node.

Here is the call graph for this function:

◆ SetPhy()

void ns3::WifiNetDevice::SetPhy ( const Ptr< WifiPhy > phy )

Parameters

phy	the PHY layer to use.

Definition at line 253 of file wifi-net-device.cc.

References CompleteConfig(), m_linkUp, m_phys, and third::phy.

Referenced by PowerRateAdaptationTest::ConfigureNode(), ns3::MeshHelper::CreateInterface(), WifiTest::CreateOne(), InterferenceHelperSequenceTest::CreateOne(), DcfImmediateAccessBroadcastTestCase::DoRun(), Bug2831TestCase::DoRun(), SpectrumWifiPhyBasicTest::DoSetup(), SpectrumWifiPhyFilterTest::DoSetup(), WifiPhyCcaThresholdsTest::DoSetup(), WifiPhyCcaIndicationTest::DoSetup(), TestDlMuMimoPhyTransmission::DoSetup(), TestUlMuMimoPhyTransmission::DoSetup(), TestDlOfdmaPhyTransmission::DoSetup(), TestDlOfdmaPhyPuncturing::DoSetup(), TestUlOfdmaPpduUid::DoSetup(), TestMultipleHeTbPreambles::DoSetup(), TestUlOfdmaPhyTransmission::DoSetup(), TestPhyPaddingExclusion::DoSetup(), WifiPhyReceptionTest::DoSetup(), TestUnsupportedBandwidthReception::DoSetup(), TestSpectrumChannelWithBandwidthFilter::DoSetup(), WifiPhyThresholdsTest::DoSetup(), GetTypeId(), and InterferenceExperiment::Run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPhys()

void ns3::WifiNetDevice::SetPhys ( const std::vector< Ptr< WifiPhy >> & phys )

Parameters

phys	the PHY layers to use (for 11be multi-link devices only)

Definition at line 262 of file wifi-net-device.cc.

References CompleteConfig(), m_ehtConfiguration, m_linkUp, m_phys, and NS_ABORT_MSG_IF.

Referenced by AmpduAggregationTest::DoSetup(), and ns3::WifiHelper::Install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPromiscReceiveCallback()

void ns3::WifiNetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback cb )

overridevirtual

Parameters

cb	callback to invoke whenever a packet has been received in promiscuous mode and must be forwarded to the higher layers.

Enables netdevice promiscuous mode and sets the callback that will handle promiscuous mode packets. Note, promiscuous mode packets means all packets, including those packets that can be sensed by the netdevice but which are intended to be received by other hosts.

Implements ns3::NetDevice.

Definition at line 599 of file wifi-net-device.cc.

References m_mac, m_promiscRx, and ns3::WifiMac::SetPromisc().

Here is the call graph for this function: