ns-3
ns3::WifiNetDevice Class Reference

Hold together all Wifi-related objects.This class holds together ns3::WifiChannel, ns3::WifiPhy, ns3::WifiMac, and, ns3::WifiRemoteStationManager. 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)
Ptr< WifiMacGetMac (void) const
Ptr< WifiPhyGetPhy (void) const
Ptr< WifiRemoteStationManagerGetRemoteStationManager (void) const
virtual void SetIfIndex (const uint32_t index)
virtual uint32_t GetIfIndex (void) const
virtual Ptr< ChannelGetChannel (void) const
virtual void SetAddress (Address address)
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 AddLinkChangeCallback (Callback< void > callback)
virtual bool IsBroadcast (void) const
virtual Address GetBroadcast (void) const
virtual bool IsMulticast (void) const
virtual Address GetMulticast (Ipv4Address multicastGroup) const
 Make and return a MAC multicast address using the provided multicast group.
virtual bool IsPointToPoint (void) const
 Return true if the net device is on a point-to-point link.
virtual bool IsBridge (void) const
 Return true if the net device is acting as a bridge.
virtual bool Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)
virtual Ptr< NodeGetNode (void) const
virtual void SetNode (Ptr< Node > node)
virtual bool NeedsArp (void) const
virtual void SetReceiveCallback (NetDevice::ReceiveCallback cb)
virtual Address GetMulticast (Ipv6Address addr) const
 Get the MAC multicast address corresponding to the IPv6 address provided.
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.

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
}
typedef Callback< bool, Ptr
< NetDevice >, Ptr< const
Packet >, uint16_t, const
Address & > 
ReceiveCallback
typedef Callback< bool, Ptr
< NetDevice >, Ptr< const
Packet >, uint16_t, const
Address &, const Address
&, enum PacketType
PromiscReceiveCallback

Detailed Description

Hold together all Wifi-related objects.

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


Member Function Documentation

void ns3::WifiNetDevice::AddLinkChangeCallback ( Callback< void >  callback)
virtual
Parameters:
callbackthe 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.

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

Address ns3::WifiNetDevice::GetAddress ( void  ) const
virtual
Returns:
the current Address of this interface.

Implements ns3::NetDevice.

References ns3::WifiMac::GetAddress().

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.

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.

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.

Referenced by GetTypeId().

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.

Referenced by GetTypeId().

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:
multicastGroupThe 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.

Referenced by GetMulticast().

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

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

Parameters:
addrIPv6 address
Returns:
the MAC multicast address
Warning:
Calling this method is invalid if IsMulticast returns not true.

Implements ns3::NetDevice.

References GetMulticast().

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.

Referenced by GetTypeId().

Ptr< WifiRemoteStationManager > ns3::WifiNetDevice::GetRemoteStationManager ( void  ) const
Returns:
the remote station manager we are currently using.

Referenced by GetTypeId().

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]/$ns3::WifiNetDevice

Attributes defined for this type:

No TraceSources defined for this type.

Reimplemented from ns3::NetDevice.

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

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.

bool ns3::WifiNetDevice::IsBroadcast ( void  ) const
virtual
Returns:
true if this interface supports a broadcast address, false otherwise.

Implements ns3::NetDevice.

bool ns3::WifiNetDevice::IsLinkUp ( void  ) const
virtual
Returns:
true if link is up; false otherwise

Implements ns3::NetDevice.

bool ns3::WifiNetDevice::IsMulticast ( void  ) const
virtual
Returns:
value of m_isMulticast flag

Implements ns3::NetDevice.

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.

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.

bool ns3::WifiNetDevice::Send ( Ptr< Packet packet,
const Address dest,
uint16_t  protocolNumber 
)
virtual
Parameters:
packetpacket sent from above down to Network Device
destmac address of the destination (already resolved)
protocolNumberidentifies 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.

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

bool ns3::WifiNetDevice::SendFrom ( Ptr< Packet packet,
const Address source,
const Address dest,
uint16_t  protocolNumber 
)
virtual
Parameters:
packetpacket sent from above down to Network Device
sourcesource mac address (so called "MAC spoofing")
destmac address of the destination (already resolved)
protocolNumberidentifies 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.

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

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

Set the address of this interface

Parameters:
addressaddress to set

Implements ns3::NetDevice.

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

void ns3::WifiNetDevice::SetIfIndex ( const uint32_t  index)
virtual
Parameters:
indexifIndex of the device

Implements ns3::NetDevice.

void ns3::WifiNetDevice::SetMac ( Ptr< WifiMac mac)
Parameters:
macthe mac layer to use.

Referenced by GetTypeId().

bool ns3::WifiNetDevice::SetMtu ( const uint16_t  mtu)
virtual
Parameters:
mtuMTU 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.

Referenced by GetTypeId().

void ns3::WifiNetDevice::SetNode ( Ptr< Node node)
virtual
Parameters:
nodethe node associated to this netdevice.

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

Implements ns3::NetDevice.

void ns3::WifiNetDevice::SetPhy ( Ptr< WifiPhy phy)
Parameters:
phythe phy layer to use.

Referenced by GetTypeId().

void ns3::WifiNetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback  cb)
virtual
Parameters:
cbcallback 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.

References ns3::WifiMac::SetPromisc().

void ns3::WifiNetDevice::SetReceiveCallback ( NetDevice::ReceiveCallback  cb)
virtual
Parameters:
cbcallback 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:
managerthe manager to use.

Referenced by GetTypeId().

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: