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

#include "wifi-net-device.h"

Inheritance diagram for ns3::WifiNetDevice:

Public Member Functions
	WifiNetDevice ()

virtual	~WifiNetDevice ()

void	AddLinkChangeCallback (Callback< void > callback)

Address	GetAddress (void) const

Address	GetBroadcast (void) const

Ptr< Channel >	GetChannel (void) const

uint32_t	GetIfIndex (void) const

Ptr< WifiMac >	GetMac (void) const

uint16_t	GetMtu (void) const

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

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

Ptr< Node >	GetNode (void) const

Ptr< WifiPhy >	GetPhy (void) const

Ptr< WifiRemoteStationManager >	GetRemoteStationManager (void) const

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

bool	IsBroadcast (void) const

bool	IsLinkUp (void) const

bool	IsMulticast (void) const

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

bool	NeedsArp (void) const

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

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

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

void	SetIfIndex (const uint32_t index)

void	SetMac (const Ptr< WifiMac > mac)

bool	SetMtu (const uint16_t mtu)

void	SetNode (const Ptr< Node > node)

void	SetPhy (const Ptr< WifiPhy > phy)

void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)

void	SetReceiveCallback (NetDevice::ReceiveCallback cb)

void	SetRemoteStationManager (const Ptr< WifiRemoteStationManager > manager)

bool	SupportsSendFrom (void) const

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

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

virtual	~Object ()
	Destructor. More...

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

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

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

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

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

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

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

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

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

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

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

void	Unref (void) const
	Decrement the reference count. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Member Functions
	WifiNetDevice (const WifiNetDevice &o)
	Copy constructor. More...

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

void	FlowControlConfig (void)
	Perform the actions needed to support flow control and dynamic queue limits. More...

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

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

WifiNetDevice &	operator= (const WifiNetDevice &o)
	Assignment operator. More...

uint8_t	SelectQueue (Ptr< QueueItem > item) const
	Determine the tx queue for a given packet. More...

Private Attributes
bool	m_configComplete
	configuration complete More...

NetDevice::ReceiveCallback	m_forwardUp
	forward up callback 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...

Ptr< WifiPhy >	m_phy
	the phy More...

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

Ptr< NetDeviceQueueInterface >	m_queueInterface
	NetDevice queue interface. More...

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

Ptr< WifiRemoteStationManager >	m_stationManager
	the station manager More...

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

Additional Inherited Members
Public Types inherited from ns3::NetDevice
typedef void(*	LinkChangeTracedCallback) (void)
	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 &, enum PacketType >	PromiscReceiveCallback

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

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

Detailed Description

Hold together all Wifi-related objects.

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

Config Paths

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

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

Attributes

Mtu: The MAC-level Maximum Transmission Unit
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 1:2296
- Initial value: 2296
- Flags: construct write read
Channel: The channel attached to this device
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::Channel>
- Flags: read
Phy: The PHY layer attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::WifiPhy>
- Initial value: 0x0
- Flags: construct write read
Mac: The MAC layer attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::WifiMac>
- Initial value: 0x0
- Flags: construct write read
RemoteStationManager: The station manager attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::WifiRemoteStationManager>
- Initial value: 0x0
- Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 176 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ WifiNetDevice() [1/2]

ns3::WifiNetDevice::WifiNetDevice ( )

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

References NS_LOG_FUNCTION_NOARGS.

◆ ~WifiNetDevice()

ns3::WifiNetDevice::~WifiNetDevice ( )

virtual

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

References NS_LOG_FUNCTION_NOARGS.

◆ WifiNetDevice() [2/2]

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

private

Copy constructor.

Parameters

o	object to copy

Defined and unimplemented to avoid misuse

Member Function Documentation

◆ AddLinkChangeCallback()

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

virtual

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

References ns3::TracedCallback< T1, T2, T3, T4, T5, T6, T7, T8 >::ConnectWithoutContext(), and m_linkChanges.

◆ CompleteConfig()

void ns3::WifiNetDevice::CompleteConfig ( void )

private

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

MAC, WifiRemoteStation) together.

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

References ForwardUp(), LinkDown(), LinkUp(), m_configComplete, m_mac, m_node, m_phy, m_stationManager, ns3::MakeCallback(), ns3::WifiRemoteStationManager::SetupMac(), and ns3::WifiRemoteStationManager::SetupPhy().

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

◆ DoDispose()

void ns3::WifiNetDevice::DoDispose ( void )

protectedvirtual

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

References ns3::Object::Dispose(), ns3::Object::DoDispose(), m_mac, m_node, m_phy, m_queueInterface, m_stationManager, and NS_LOG_FUNCTION_NOARGS.

◆ DoInitialize()

void ns3::WifiNetDevice::DoInitialize ( void )

protectedvirtual

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

References ns3::Object::DoInitialize(), ns3::Object::Initialize(), m_mac, m_phy, m_stationManager, and NS_LOG_FUNCTION_NOARGS.

◆ FlowControlConfig()

void ns3::WifiNetDevice::FlowControlConfig ( void )

private

Perform the actions needed to support flow control and dynamic queue limits.

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

References ns3::BooleanValue::Get(), ns3::PointerValue::Get(), m_mac, m_queueInterface, third::mac, and NS_LOG_WARN.

Referenced by NotifyNewAggregate(), and SetMac().

◆ ForwardUp()

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

protected

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

Parameters

packet
from
to

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

References ns3::LlcSnapHeader::GetType(), ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsGroup(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_forwardUp, m_mac, m_promiscRx, NS_LOG_FUNCTION, ns3::NetDevice::PACKET_BROADCAST, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, ns3::NetDevice::PACKET_OTHERHOST, and ns3::Packet::RemoveHeader().

Referenced by CompleteConfig().

◆ GetAddress()

Address ns3::WifiNetDevice::GetAddress ( void ) const

virtual

Returns: the current Address of this interface.

Implements ns3::NetDevice.

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

References m_mac.

Referenced by Bug730TestCase::DoRun(), and OcbWifiMacTestCase::PostDeviceConfiguration().

◆ GetBroadcast()

Address ns3::WifiNetDevice::GetBroadcast ( void ) const

virtual

Returns: the broadcast address supported by this netdevice.

Calling this method is invalid if IsBroadcast returns not true.

Implements ns3::NetDevice.

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

References ns3::Mac48Address::GetBroadcast().

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

◆ GetChannel()

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

virtual

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

References ns3::WifiPhy::GetChannel(), and m_phy.

Referenced by GetTypeId().

◆ GetIfIndex()

uint32_t ns3::WifiNetDevice::GetIfIndex ( void ) const

virtual

Returns: index ifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex.

Referenced by Bug2222TestCase::DoRun().

◆ GetMac()

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

Returns: the mac we are currently using.

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

References m_mac.

Referenced by GetTypeId(), NodeStatistics::NodeStatistics(), OcbWifiMacTestCase::PostDeviceConfiguration(), Experiment::Run(), and StaWifiMacScanningTestCase::TurnBeaconGenerationOn().

◆ GetMtu()

uint16_t ns3::WifiNetDevice::GetMtu ( void ) const

virtual

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

References m_mtu.

Referenced by GetTypeId().

◆ GetMulticast() [1/2]

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

virtual

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

References ns3::Mac48Address::GetMulticast().

◆ GetMulticast() [2/2]

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

virtual

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

References ns3::Mac48Address::GetMulticast().

◆ GetNode()

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

virtual

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

References m_node.

◆ GetPhy()

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

Returns: the phy we are currently using.

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

References m_phy.

Referenced by GetTypeId(), GetYansWifiPhyPtr(), SetChannelFrequencyTest::GetYansWifiPhyPtr(), NodeStatistics::NodeStatistics(), InterferenceHelperSequenceTest::SwitchCh(), and StaWifiMacScanningTestCase::TurnApOff().

◆ GetRemoteStationManager()

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

Returns: the remote station manager we are currently using.

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

References m_stationManager.

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

◆ GetTypeId()

TypeId ns3::WifiNetDevice::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References GetChannel(), GetMac(), GetMtu(), GetPhy(), GetRemoteStationManager(), ns3::LLC_SNAP_HEADER_LENGTH, ns3::MakePointerAccessor(), ns3::MakeUintegerAccessor(), ns3::MAX_MSDU_SIZE, SetMac(), SetMtu(), ns3::TypeId::SetParent(), SetPhy(), and SetRemoteStationManager().

◆ IsBridge()

bool ns3::WifiNetDevice::IsBridge ( void ) const

virtual

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

Returns: value of m_isBridge flag

Implements ns3::NetDevice.

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

◆ IsBroadcast()

bool ns3::WifiNetDevice::IsBroadcast ( void ) const

virtual

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

Implements ns3::NetDevice.

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

◆ IsLinkUp()

bool ns3::WifiNetDevice::IsLinkUp ( void ) const

virtual

Returns: true if link is up; false otherwise

Implements ns3::NetDevice.

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

References m_linkUp, and m_phy.

◆ IsMulticast()

bool ns3::WifiNetDevice::IsMulticast ( void ) const

virtual

Returns: value of m_isMulticast flag

Implements ns3::NetDevice.

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

◆ IsPointToPoint()

bool ns3::WifiNetDevice::IsPointToPoint ( void ) const

virtual

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

◆ LinkDown()

void ns3::WifiNetDevice::LinkDown ( void )

private

Set that the link is down (i.e.

STA is not associated).

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

References m_linkChanges, and m_linkUp.

Referenced by CompleteConfig().

◆ LinkUp()

void ns3::WifiNetDevice::LinkUp ( void )

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

References m_linkChanges, and m_linkUp.

Referenced by CompleteConfig().

◆ NeedsArp()

bool ns3::WifiNetDevice::NeedsArp ( void ) const

virtual

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

◆ NotifyNewAggregate()

void ns3::WifiNetDevice::NotifyNewAggregate ( void )

protectedvirtual

Notify all Objects aggregated to this one of a new Object being aggregated.

This function must be implemented in the stack that needs to notify other stacks connected to the node of their presence in the node.

This method is invoked whenever two sets of Objects are aggregated together. It is invoked exactly once for each Object in both sets. This method can be overridden by subclasses who wish to be notified of aggregation events. These subclasses must chain up to their base class NotifyNewAggregate() method.

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

Reimplemented from ns3::Object.

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

References FlowControlConfig(), m_queueInterface, ns3::MakeCallback(), ns3::Object::NotifyNewAggregate(), NS_LOG_FUNCTION, and SelectQueue().

◆ operator=()

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

private

Assignment operator.

Parameters

o	object to copy

Returns: the copied object

Defined and unimplemented to avoid misuse

◆ SelectQueue()

uint8_t ns3::WifiNetDevice::SelectQueue ( Ptr< QueueItem > item ) const

private

Determine the tx queue for a given packet.

Parameters

item	the packet

Returns: the access category

Modelled after the Linux function ieee80211_select_queue (net/mac80211/wme.c). A SocketPriority tag is attached to the packet (or the existing one is replaced) to carry the user priority, which is set to the three most significant bits of the DS field (TOS field in case of IPv4 and Traffic Class field in case of IPv6). The Access Category corresponding to the user priority according to the QosUtilsMapTidToAc function is returned.

The following table shows the mapping for the Diffserv Per Hop Behaviors.

PHB	TOS (binary)	UP	Access Category
EF	101110xx	5	AC_VI
AF11	001010xx	1	AC_BK
AF21	010010xx	2	AC_BK
AF31	011010xx	3	AC_BE
AF41	100010xx	4	AC_VI
AF12	001100xx	1	AC_BK
AF22	010100xx	2	AC_BK
AF32	011100xx	3	AC_BE
AF42	100100xx	4	AC_VI
AF13	001110xx	1	AC_BK
AF23	010110xx	2	AC_BK
AF33	011110xx	3	AC_BE
AF43	100110xx	4	AC_VI
CS0	000000xx	0	AC_BE
CS1	001000xx	1	AC_BK
CS2	010000xx	2	AC_BK
CS3	011000xx	3	AC_BE
CS4	100000xx	4	AC_VI
CS5	101000xx	5	AC_VI
CS6	110000xx	6	AC_VO
CS7	111000xx	7	AC_VO

This method is called by the traffic control layer before enqueuing a packet in the queue disc, if a queue disc is installed on the outgoing device, or passing a packet to the device, otherwise.

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

References ns3::QueueItem::IP_DSFIELD, m_queueInterface, NS_ASSERT, NS_LOG_FUNCTION, ns3::QosUtilsMapTidToAc(), and ns3::SocketPriorityTag::SetPriority().

Referenced by NotifyNewAggregate().

◆ Send()

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

virtual

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

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

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

◆ SendFrom()

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

virtual

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

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

◆ SetAddress()

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

virtual

Set the address of this interface.

Parameters

address address to set

Implements ns3::NetDevice.

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

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

◆ SetIfIndex()

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

virtual

Parameters

index ifIndex of the device

Implements ns3::NetDevice.

Definition at line 243 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 203 of file wifi-net-device.cc.

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

Referenced by GetTypeId().

◆ SetMtu()

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

virtual

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

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

Referenced by GetTypeId().

◆ SetNode()

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

virtual

Parameters

node	the node associated to this netdevice.

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

Implements ns3::NetDevice.

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

References CompleteConfig(), and m_node.

◆ SetPhy()

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

Parameters

phy	the phy layer to use.

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

References CompleteConfig(), m_phy, and third::phy.

Referenced by GetTypeId().

◆ SetPromiscReceiveCallback()

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

virtual

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

References m_mac, and m_promiscRx.

◆ SetReceiveCallback()

void ns3::WifiNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback cb )

virtual

Parameters

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

Set the callback to be used to notify higher layers when a packet has been received.

Implements ns3::NetDevice.

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

References m_forwardUp.

◆ SetRemoteStationManager()

void ns3::WifiNetDevice::SetRemoteStationManager ( const Ptr< WifiRemoteStationManager > manager )

Parameters

manager the manager to use.

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

References CompleteConfig(), and m_stationManager.

Referenced by GetTypeId().

◆ SupportsSendFrom()

bool ns3::WifiNetDevice::SupportsSendFrom ( void ) const

virtual

Returns: true if this interface supports a bridging mode, false otherwise.

Implements ns3::NetDevice.

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

References m_mac.

Member Data Documentation

◆ m_configComplete

bool ns3::WifiNetDevice::m_configComplete

private

configuration complete

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

Referenced by CompleteConfig().

◆ m_forwardUp

NetDevice::ReceiveCallback ns3::WifiNetDevice::m_forwardUp

private

forward up callback

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

Referenced by ForwardUp(), and SetReceiveCallback().

◆ m_ifIndex

uint32_t ns3::WifiNetDevice::m_ifIndex

private

IF index.

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

Referenced by GetIfIndex(), and SetIfIndex().

◆ m_linkChanges

TracedCallback ns3::WifiNetDevice::m_linkChanges

private

link change callback

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

Referenced by AddLinkChangeCallback(), LinkDown(), and LinkUp().

◆ m_linkUp

bool ns3::WifiNetDevice::m_linkUp

private

link up

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

Referenced by IsLinkUp(), LinkDown(), and LinkUp().

◆ m_mac

Ptr<WifiMac> ns3::WifiNetDevice::m_mac

private

the MAC

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

Referenced by CompleteConfig(), DoDispose(), DoInitialize(), FlowControlConfig(), ForwardUp(), GetAddress(), GetMac(), Send(), SendFrom(), SetAddress(), SetMac(), SetPromiscReceiveCallback(), and SupportsSendFrom().

◆ m_mtu

uint16_t ns3::WifiNetDevice::m_mtu

mutableprivate

MTU.

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

Referenced by GetMtu(), and SetMtu().

◆ m_node

Ptr<Node> ns3::WifiNetDevice::m_node

private

the node

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

Referenced by CompleteConfig(), DoDispose(), GetNode(), and SetNode().

◆ m_phy

Ptr<WifiPhy> ns3::WifiNetDevice::m_phy

private

the phy

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

Referenced by CompleteConfig(), DoDispose(), DoInitialize(), GetChannel(), GetPhy(), IsLinkUp(), and SetPhy().

◆ m_promiscRx

NetDevice::PromiscReceiveCallback ns3::WifiNetDevice::m_promiscRx

private

promiscious receive callback

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

Referenced by ForwardUp(), and SetPromiscReceiveCallback().

◆ m_queueInterface

Ptr<NetDeviceQueueInterface> ns3::WifiNetDevice::m_queueInterface

private

NetDevice queue interface.

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

Referenced by DoDispose(), FlowControlConfig(), NotifyNewAggregate(), and SelectQueue().

◆ m_rxLogger

TracedCallback<Ptr<const Packet>, Mac48Address> ns3::WifiNetDevice::m_rxLogger

private

receive trace callback

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

◆ m_stationManager

Ptr<WifiRemoteStationManager> ns3::WifiNetDevice::m_stationManager

private

the station manager

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

Referenced by CompleteConfig(), DoDispose(), DoInitialize(), GetRemoteStationManager(), and SetRemoteStationManager().

◆ m_txLogger

TracedCallback<Ptr<const Packet>, Mac48Address> ns3::WifiNetDevice::m_txLogger

private

transmit trace callback

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

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

src/wifi/model/wifi-net-device.h
src/wifi/model/wifi-net-device.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Constructor & Destructor Documentation

◆ WifiNetDevice() [1/2]

◆ ~WifiNetDevice()

◆ WifiNetDevice() [2/2]

Member Function Documentation

◆ AddLinkChangeCallback()

◆ CompleteConfig()

◆ DoDispose()

◆ DoInitialize()

◆ FlowControlConfig()

◆ ForwardUp()

◆ GetAddress()

◆ GetBroadcast()

◆ GetChannel()

◆ GetIfIndex()

◆ GetMac()

◆ GetMtu()

◆ GetMulticast() [1/2]

◆ GetMulticast() [2/2]

◆ GetNode()

◆ GetPhy()

◆ GetRemoteStationManager()

◆ GetTypeId()

◆ IsBridge()

◆ IsBroadcast()

◆ IsLinkUp()

◆ IsMulticast()

◆ IsPointToPoint()

◆ LinkDown()

◆ LinkUp()

◆ NeedsArp()

◆ NotifyNewAggregate()

◆ operator=()

◆ SelectQueue()

◆ Send()

◆ SendFrom()

◆ SetAddress()

◆ SetIfIndex()

◆ SetMac()

◆ SetMtu()

◆ SetNode()

◆ SetPhy()

◆ SetPromiscReceiveCallback()

◆ SetReceiveCallback()

◆ SetRemoteStationManager()

◆ SupportsSendFrom()

Member Data Documentation

◆ m_configComplete

◆ m_forwardUp

◆ m_ifIndex

◆ m_linkChanges

◆ m_linkUp

◆ m_mac

◆ m_mtu

◆ m_node

◆ m_phy

◆ m_promiscRx

◆ m_queueInterface

◆ m_rxLogger

◆ m_stationManager

◆ m_txLogger