ns3::NetDevice Class Reference
[NetDevice]

Network layer to device interface. More...

#include <net-device.h>

Inheritance diagram for ns3::NetDevice:

Inheritance graph
[legend]
Collaboration diagram for ns3::NetDevice:

Collaboration graph
[legend]

List of all members.

Public Types

enum  PacketType { PACKET_HOST = 1 , PACKET_BROADCAST , PACKET_MULTICAST , 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

Public Member Functions

virtual void SetIfIndex (const uint32_t index)=0
virtual uint32_t GetIfIndex (void) const =0
virtual Ptr< Channel > GetChannel (void) const =0
virtual void SetAddress (Address address)=0
virtual Address GetAddress (void) const =0
virtual bool SetMtu (const uint16_t mtu)=0
virtual uint16_t GetMtu (void) const =0
virtual bool IsLinkUp (void) const =0
virtual void SetLinkChangeCallback (Callback< void > callback)=0
virtual bool IsBroadcast (void) const =0
virtual Address GetBroadcast (void) const =0
virtual bool IsMulticast (void) const =0
virtual Address GetMulticast (Ipv4Address multicastGroup) const =0
 Make and return a MAC multicast address using the provided multicast group.
virtual Address GetMulticast (Ipv6Address addr) const =0
 Get the MAC multicast address corresponding to the IPv6 address provided.
virtual bool IsBridge (void) const =0
 Return true if the net device is acting as a bridge.
virtual bool IsPointToPoint (void) const =0
 Return true if the net device is on a point-to-point link.
virtual bool Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber)=0
virtual bool SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber)=0
virtual Ptr< Node > GetNode (void) const =0
virtual void SetNode (Ptr< Node > node)=0
virtual bool NeedsArp (void) const =0
virtual void SetReceiveCallback (ReceiveCallback cb)=0
virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb)=0
virtual bool SupportsSendFrom (void) const =0

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::NetDevice.

Detailed Description

Network layer to device interface.

This interface defines the API which the IP and ARP layers need to access to manage an instance of a network device layer. It currently does not support MAC-level multicast but this should not be too hard to add by adding extra methods to register MAC multicast addresses to filter out unwanted packets before handing them to the higher layers.

In Linux, this interface is analogous to the interface just above dev_queue_xmit() (i.e., IP packet is fully constructed with destination MAC address already selected).

If you want to write a new MAC layer, you need to subclass this base class and implement your own version of the NetDevice::SendTo method.

This class was designed to hide as many MAC-level details as possible from the perspective of layer 3 to allow a single layer 3 to work with any kind of MAC layer. Specifically, this class encapsulates the specific format of MAC addresses used by a device such that the layer 3 does not need any modification to handle new address formats. This means obviously that the NetDevice class must know about the address format of all potential layer 3 protocols through its GetMulticast methods: the current API has been optimized to make it easy to add new MAC protocols, not to add new layer 3 protocols.

Member Typedef Documentation

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

Parameters:
device a pointer to the net device which is calling this callback
packet the packet received
protocol the 16 bit protocol number associated with this packet. This protocol number is expected to be the same protocol number given to the Send method by the user on the sender side.
sender the address of the sender
receiver the address of the receiver
packetType type of packet received (broadcast/multicast/unicast/otherhost)
Returns:
true if the callback could handle the packet successfully, false otherwise.

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

Parameters:
device a pointer to the net device which is calling this callback
packet the packet received
protocol the 16 bit protocol number associated with this packet. This protocol number is expected to be the same protocol number given to the Send method by the user on the sender side.
sender the address of the sender
Returns:
true if the callback could handle the packet successfully, false otherwise.

Member Enumeration Documentation

enum ns3::NetDevice::PacketType

Packet types are used as they are in Linux. GCC name resolution on typedef enum {} PacketType is broken for the foreseeable future, so if you need to use ns-3 PacketType in a driver that also uses the Linux packet types you're hosed unless we define a shadow type, which we do here.

Enumerator:
PACKET_HOST  Packet addressed oo us
PACKET_BROADCAST  Packet addressed to all
PACKET_MULTICAST  Packet addressed to multicast group
PACKET_OTHERHOST  Packet addressed to someone else

Member Function Documentation

virtual Address ns3::NetDevice::GetAddress ( void   )  const [pure virtual]

Returns:
the current Address of this interface.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual Address ns3::NetDevice::GetBroadcast ( void   )  const [pure virtual]

Returns:
the broadcast address supported by this netdevice.
Calling this method is invalid if IsBroadcast returns not true.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual Ptr<Channel> ns3::NetDevice::GetChannel ( void   )  const [pure 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.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual uint32_t ns3::NetDevice::GetIfIndex ( void   )  const [pure virtual]

Returns:
index ifIndex of the device

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual uint16_t ns3::NetDevice::GetMtu ( void   )  const [pure 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.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual Address ns3::NetDevice::GetMulticast ( Ipv6Address  addr  )  const [pure 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.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual Address ns3::NetDevice::GetMulticast ( Ipv4Address  multicastGroup  )  const [pure 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 GetMulticast 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

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual Ptr<Node> ns3::NetDevice::GetNode ( void   )  const [pure 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.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

static TypeId ns3::NetDevice::GetTypeId ( void   )  [static]

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

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

  • /NodeList/[i]/DeviceList/[i]
Attributes defined for this type:
  • Mtu: The MAC-level Maximum Transmission Unit
No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsBridge ( void   )  const [pure virtual]

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

Returns:
value of m_isBridge flag

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsBroadcast ( void   )  const [pure virtual]

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

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsLinkUp ( void   )  const [pure virtual]

Returns:
true if link is up; false otherwise

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsMulticast ( void   )  const [pure virtual]

Returns:
value of m_isMulticast flag

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsPointToPoint ( void   )  const [pure virtual]

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

Returns:
value of m_isPointToPoint flag

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::NeedsArp ( void   )  const [pure virtual]

Returns:
true if ARP is needed, false otherwise.
Called by higher-layers to check if this NetDevice requires ARP to be used.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::Send ( Ptr< Packet >  packet,
const Address &  dest,
uint16_t  protocolNumber 
) [pure 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

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::SendFrom ( Ptr< Packet >  packet,
const Address &  source,
const Address &  dest,
uint16_t  protocolNumber 
) [pure 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

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetAddress ( Address  address  )  [pure virtual]

Set the address of this interface

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetIfIndex ( const uint32_t  index  )  [pure virtual]

Parameters:
index ifIndex of the device

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetLinkChangeCallback ( Callback< void >  callback  )  [pure 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.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::SetMtu ( const uint16_t  mtu  )  [pure 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.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetNode ( Ptr< Node >  node  )  [pure virtual]

Parameters:
node the node associated to this netdevice.
This method is called from ns3::Node::AddDevice.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback  cb  )  [pure 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.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetReceiveCallback ( ReceiveCallback  cb  )  [pure virtual]

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

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::SupportsSendFrom ( void   )  const [pure virtual]

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

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::TapBridge, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::LoopbackNetDevice, and ns3::SimpleNetDevice.

The documentation for this class was generated from the following files:
Generated on Fri Apr 9 15:01:11 2010 for NS-3 by  doxygen 1.5.8