ns3::WifiNetDevice Class Reference

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

#include <wifi-net-device.h>

Inheritance diagram for ns3::WifiNetDevice:

Collaboration diagram for ns3::WifiNetDevice:

List of all members.

Public Member Functions
void	SetMac (Ptr< WifiMac > mac)
void	SetPhy (Ptr< WifiPhy > phy)
void	SetRemoteStationManager (Ptr< WifiRemoteStationManager > manager)
void	SetChannel (Ptr< WifiChannel > channel)
Ptr< WifiMac >	GetMac (void) const
Ptr< WifiPhy >	GetPhy (void) const
Ptr< WifiRemoteStationManager >	GetRemoteStationManager (void) const
virtual void	SetName (const std::string name)
virtual std::string	GetName (void) const
virtual void	SetIfIndex (const uint32_t index)
virtual uint32_t	GetIfIndex (void) const
virtual Ptr< Channel >	GetChannel (void) const
virtual Address	GetAddress (void) const
virtual bool	SetMtu (const uint16_t mtu)
virtual uint16_t	GetMtu (void) const
virtual bool	IsLinkUp (void) const
virtual void	SetLinkChangeCallback (Callback< void > callback)
virtual bool	IsBroadcast (void) const
virtual Address	GetBroadcast (void) const
virtual bool	IsMulticast (void) const
virtual Address	GetMulticast (void) const
	Return the MAC multicast base address used when mapping multicast groups to MAC multicast addresses.
virtual Address	MakeMulticastAddress (Ipv4Address multicastGroup) const
	Make and return a MAC multicast address using the provided multicast group.
virtual bool	IsPointToPoint (void) const
virtual bool	Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
virtual Ptr< Node >	GetNode (void) const
virtual void	SetNode (Ptr< Node > node)
virtual bool	NeedsArp (void) const
virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)
virtual bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)
virtual void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)
virtual bool	SupportsSendFrom (void) const
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::WifiNetDevice.
Private Member Functions
virtual void	DoDispose (void)

---

Detailed Description

Hold together all Wifi-related objects.

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

---

Member Function Documentation

virtual void ns3::WifiNetDevice::DoDispose

(

void

)

[private, virtual]

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.

Reimplemented from ns3::Object.

virtual Address ns3::WifiNetDevice::GetAddress

(

void

)

const [virtual]

Returns:

the current Address of this interface.

Implements ns3::NetDevice.

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

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

Implements ns3::NetDevice.

virtual uint32_t ns3::WifiNetDevice::GetIfIndex

(

void

)

const [virtual]

Returns:

index ifIndex of the device

Implements ns3::NetDevice.

Ptr<WifiMac> ns3::WifiNetDevice::GetMac

(

void

)

const

Returns:

the mac we are currently using.

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

virtual Address ns3::WifiNetDevice::GetMulticast

(

void

)

const [virtual]

Return the MAC multicast base address used when mapping multicast groups to MAC multicast addresses.

Typically when one constructs a multicast MAC addresses, some bits from the IP multicast group are copied into a corresponding MAC multicast group. In EUI-48, for example, the low order 23 bits of the multicast group are copied to the MAC multicast group base address.

This method allows access to the underlying MAC multicast group base address. It is expected that in most cases, a net device client will allow the net device to perform the actual construction of the multicast address. Use of this method is discouraged unless you have a good reason to perform a custom mapping. You should prefer NetDevice::MakeMulticastAddress which will do the RFC-specified mapping for the net device in question.

Returns:

The multicast address supported by this net device.

Warning:

Calling this method is invalid if IsMulticast returns not true. The method NS_ASSERTs if the device is not a multicast device.

See also:

NetDevice::MakeMulticastAddress

Implements ns3::NetDevice.

virtual std::string ns3::WifiNetDevice::GetName

(

void

)

const [virtual]

Returns:

name name of the device (e.g. "eth0")

Implements ns3::NetDevice.

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

Ptr<WifiPhy> ns3::WifiNetDevice::GetPhy

(

void

)

const

Returns:

the phy we are currently using.

Ptr<WifiRemoteStationManager> ns3::WifiNetDevice::GetRemoteStationManager

(

void

)

const

Returns:

the remote station manager we are currently using.

static TypeId ns3::WifiNetDevice::GetTypeId

(

void

)

[static]

This method returns the TypeId associated to ns3::WifiNetDevice.

This object is accessible through the following paths with Config::Set and Config::Connect:

• /NodeList/[i]/DeviceList/[i]/$ns3WifiNetDevice

Attributes defined for this type:

• Channel: The channel attached to this device
  • Set with class: ns3::PointerValue
  • Underlying type: ns3::Ptr< ns3::WifiChannel >
  • Initial value: 0
  • Flags: construct write 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

Attributes defined in parent class ns3::NetDevice:

• Mtu: The MAC-level Maximum Transmission Unit
  • Set with class: ns3::UintegerValue
  • Underlying type: uint16_t 0:65535
  • Flags: write read

TraceSources defined for this type:

• Rx: Received payload from the MAC layer.
• Tx: Send payload to the MAC layer.

Reimplemented from ns3::NetDevice.

virtual bool ns3::WifiNetDevice::IsBroadcast

(

void

)

const [virtual]

Returns:

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

Implements ns3::NetDevice.

virtual bool ns3::WifiNetDevice::IsLinkUp

(

void

)

const [virtual]

Returns:

true if link is up; false otherwise

Implements ns3::NetDevice.

virtual bool ns3::WifiNetDevice::IsMulticast

(

void

)

const [virtual]

Returns:

value of m_isMulticast flag

Implements ns3::NetDevice.

virtual bool ns3::WifiNetDevice::IsPointToPoint

(

void

)

const [virtual]

Returns:

value of m_isPointToPoint flag

Implements ns3::NetDevice.

virtual Address ns3::WifiNetDevice::MakeMulticastAddress

(

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.

A default imlementation of MakeMulticastAddress is provided, but this method simply NS_ASSERTS. 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.

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

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

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

void ns3::WifiNetDevice::SetChannel

(

Ptr< WifiChannel >

channel

)

Parameters:

channel

the channel to connect to.

virtual void ns3::WifiNetDevice::SetIfIndex

(

const uint32_t

index

)

[virtual]

Parameters:

index

ifIndex of the device

Implements ns3::NetDevice.

virtual void ns3::WifiNetDevice::SetLinkChangeCallback

(

Callback< void >

callback

)

[virtual]

Parameters:

callback

the callback to invoke

Register 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 whenever the link goes up.

Implements ns3::NetDevice.

void ns3::WifiNetDevice::SetMac

(

Ptr< WifiMac >

mac

)

Parameters:

mac

the mac layer to use.

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

virtual void ns3::WifiNetDevice::SetName

(

const std::string

name

)

[virtual]

Parameters:

name

name of the device (e.g. "eth0")

Implements ns3::NetDevice.

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

void ns3::WifiNetDevice::SetPhy

(

Ptr< WifiPhy >

phy

)

Parameters:

phy

the phy layer to use.

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

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

Implements ns3::NetDevice.

void ns3::WifiNetDevice::SetRemoteStationManager

(

Ptr< WifiRemoteStationManager >

manager

)

Parameters:

manager

the manager to use.

virtual bool ns3::WifiNetDevice::SupportsSendFrom

(

void

)

const [virtual]

Returns:

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

Implements ns3::NetDevice.

---

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

• src/devices/wifi/wifi-net-device.h
• doc/introspected-doxygen.h