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

virtual	~WifiNetDevice ()

virtual void	AddLinkChangeCallback (Callback< void > callback)

virtual Address	GetAddress (void) const

virtual Address	GetBroadcast (void) const

virtual Ptr< Channel >	GetChannel (void) const

virtual uint32_t	GetIfIndex (void) const

Ptr< WifiMac >	GetMac (void) const

virtual uint16_t	GetMtu (void) const

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

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

virtual Ptr< Node >	GetNode (void) const

Ptr< WifiPhy >	GetPhy (void) const

Ptr< WifiRemoteStationManager >	GetRemoteStationManager (void) const

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

virtual bool	IsBroadcast (void) const

virtual bool	IsLinkUp (void) const

virtual bool	IsMulticast (void) const

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

virtual bool	NeedsArp (void) const

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

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

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

virtual void	SetIfIndex (const uint32_t index)

void	SetMac (Ptr< WifiMac > mac)

virtual bool	SetMtu (const uint16_t mtu)

virtual void	SetNode (Ptr< Node > node)

void	SetPhy (Ptr< WifiPhy > phy)

virtual void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)

virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)

void	SetRemoteStationManager (Ptr< WifiRemoteStationManager > manager)

virtual bool	SupportsSendFrom (void) const

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

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

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

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

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

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

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

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

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

Protected Member Functions
virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. 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...

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

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

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

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

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

Ptr< WifiChannel >	DoGetChannel (void) const
	Return the WifiChannel this device is connected to. More...

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

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

Private Attributes
bool	m_configComplete

NetDevice::ReceiveCallback	m_forwardUp

uint32_t	m_ifIndex

TracedCallback	m_linkChanges

bool	m_linkUp

Ptr< WifiMac >	m_mac

uint16_t	m_mtu

Ptr< Node >	m_node

Ptr< WifiPhy >	m_phy

NetDevice::PromiscReceiveCallback	m_promiscRx

TracedCallback< Ptr< const Packet >, Mac48Address >	m_rxLogger

Ptr< WifiRemoteStationManager >	m_stationManager

TracedCallback< Ptr< const Packet >, Mac48Address >	m_txLogger

Static Private Attributes
static const uint16_t	MAX_MSDU_SIZE = 2304

Additional Inherited Members
Public Types inherited from ns3::NetDevice
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

Detailed Description

Hold together all Wifi-related objects.

This class holds together ns3::WifiChannel, 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::WifiChannel >
- Flags: read
Phy: The PHY layer attached to this device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::WifiPhy >
- Initial value: 0
- 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: 0
- 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: 0
- Flags: construct write read

No TraceSources are defined for this type.

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

Constructor & Destructor Documentation

ns3::WifiNetDevice::WifiNetDevice ( )

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

References NS_LOG_FUNCTION_NOARGS.

ns3::WifiNetDevice::~WifiNetDevice ( )

virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

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

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

Here is the call graph for this function:

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiNetDevice::DoDispose ( void )

protectedvirtual

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

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

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

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

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

Here is the call graph for this function:

Ptr< WifiChannel > ns3::WifiNetDevice::DoGetChannel ( void ) const

private

Return the WifiChannel this device is connected to.

Returns: WifiChannel

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

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

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::WifiNetDevice::DoInitialize ( void )

protectedvirtual

This method is called only once by Object::Initialize.

If the user calls Object::Initialize multiple times, DoInitialize is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject and AggregateObject from within this method.

Reimplemented from ns3::Object.

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

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

Here is the call graph for this function:

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 289 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, ns3::NetDevice::PACKET_BROADCAST, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, ns3::NetDevice::PACKET_OTHERHOST, and ns3::Packet::RemoveHeader().

Referenced by CompleteConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

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

virtual

Returns: the current Address of this interface.

Implements ns3::NetDevice.

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

References m_mac.

Referenced by OcbWifiMacTestCase::PostDeviceConfiguration().

Here is the caller graph for this function:

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

References ns3::Mac48Address::GetBroadcast().

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

virtual

Returns: index ifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex.

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

Returns: the mac we are currently using.

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

References m_mac.

Referenced by GetTypeId(), and OcbWifiMacTestCase::PostDeviceConfiguration().

Here is the caller graph for this function:

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

References m_mtu.

Referenced by GetTypeId().

Here is the caller graph for this function:

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: Ipv4Address; Address; NetDevice::IsMulticast

Implements ns3::NetDevice.

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

References ns3::Mac48Address::GetMulticast().

Here is the call graph for this function:

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

References ns3::Mac48Address::GetMulticast().

Here is the call graph for this function:

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

References m_node.

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

Returns: the phy we are currently using.

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

References m_phy.

Referenced by GetTypeId().

Here is the caller graph for this function:

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

Returns: the remote station manager we are currently using.

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

References m_stationManager.

Referenced by GetTypeId().

Here is the caller graph for this function:

TypeId ns3::WifiNetDevice::GetTypeId ( void )

static

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

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

Here is the call graph for this function:

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

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

virtual

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

Implements ns3::NetDevice.

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

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

virtual

Returns: true if link is up; false otherwise

Implements ns3::NetDevice.

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

References m_linkUp, and m_phy.

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

virtual

Returns: value of m_isMulticast flag

Implements ns3::NetDevice.

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

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

void ns3::WifiNetDevice::LinkDown ( void )

private

Set that the link is down (i.e.

STA is not associated).

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

References m_linkChanges, and m_linkUp.

Referenced by CompleteConfig().

Here is the caller graph for this function:

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

References m_linkChanges, and m_linkUp.

Referenced by CompleteConfig().

Here is the caller graph for this function:

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

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

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

Here is the call graph for this function:

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

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

Here is the call graph for this function:

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

virtual

Set the address of this interface.

Parameters

address address to set

Implements ns3::NetDevice.

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

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

Here is the call graph for this function:

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

virtual

Parameters

index ifIndex of the device

Implements ns3::NetDevice.

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

References m_ifIndex.

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

Parameters

mac	the mac layer to use.

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

References CompleteConfig(), and m_mac.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References ns3::LLC_SNAP_HEADER_LENGTH, m_mtu, and MAX_MSDU_SIZE.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::WifiNetDevice::SetNode ( 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 272 of file wifi-net-device.cc.

References CompleteConfig(), and m_node.

Here is the call graph for this function:

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

Parameters

phy	the phy layer to use.

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

References CompleteConfig(), and m_phy.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References m_mac, and m_promiscRx.

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

virtual

Parameters