ns3::VirtualNetDevice Class Reference

A virtual device, similar to Linux TUN/TAP interfaces. More...

#include <virtual-net-device.h>

Inheritance diagram for ns3::VirtualNetDevice:

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

Collaboration graph
[legend]

List of all members.

Public Types

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

Public Member Functions

void SetSendCallback (SendCallback transmitCb)
 Set the user callback to be called when a L2 packet is to be transmitted.
void SetNeedsArp (bool needsArp)
 Configure whether the virtual device needs ARP.
void SetIsPointToPoint (bool isPointToPoint)
 Configure whether the virtual device is point-to-point.
void SetSupportsSendFrom (bool supportsSendFrom)
 Configure whether the virtual device supports SendFrom.
bool SetMtu (const uint16_t mtu)
 Configure the reported MTU for the virtual device. The default value is 65535.
bool Receive (Ptr< Packet > packet, uint16_t protocol, const Address &source, const Address &destination, PacketType packetType)
virtual void SetIfIndex (const uint32_t index)
virtual uint32_t GetIfIndex (void) const
virtual Ptr< Channel > GetChannel (void) const
virtual void SetAddress (Address address)
virtual Address GetAddress (void) const
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 (Ipv4Address multicastGroup) const
 Make and return a MAC multicast address using the provided multicast group.
virtual Address GetMulticast (Ipv6Address addr) const
 Get the MAC multicast address corresponding to the IPv6 address provided.
virtual bool IsPointToPoint (void) const
 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)
virtual bool SendFrom (Ptr< Packet > packet, const Address &source, 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 void SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb)
virtual bool SupportsSendFrom () const
virtual bool IsBridge (void) const
 Return true if the net device is acting as a bridge.

Static Public Member Functions

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

Protected Member Functions

virtual void DoDispose (void)

Detailed Description

A virtual device, similar to Linux TUN/TAP interfaces.

A VirtualNetDevice is a "virtual" NetDevice implementation which delegates to a user callback (see method SetSendCallback()) the task of actually transmitting a packet. It also allows the user code to inject the packet as if it had been received by the VirtualNetDevice. Together, these features allow one to build tunnels. For instance, by transmitting packets into a UDP socket we end up building an IP-over-UDP-over-IP tunnel, or IP-over-IP tunnels.

The same thing could be accomplished by subclassing NetDevice directly. However, VirtualNetDevice is usually much simpler to program than a NetDevice subclass.

Member Typedef Documentation

typedef Callback<bool, Ptr<Packet>, const Address&, const Address&, uint16_t> ns3::VirtualNetDevice::SendCallback

Callback the be invoked when the VirtualNetDevice is asked to queue/transmit a packet. For more information, consult the documentation of NetDevice::SendFrom().

Member Function Documentation

virtual void ns3::VirtualNetDevice::DoDispose ( void   )  [protected, 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::VirtualNetDevice::GetAddress ( void   )  const [virtual]

Returns:
the current Address of this interface.

Implements ns3::NetDevice.

virtual Address ns3::VirtualNetDevice::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::VirtualNetDevice::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.

virtual uint32_t ns3::VirtualNetDevice::GetIfIndex ( void   )  const [virtual]

Returns:
index ifIndex of the device

Implements ns3::NetDevice.

virtual uint16_t ns3::VirtualNetDevice::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::VirtualNetDevice::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.

virtual Address ns3::VirtualNetDevice::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.

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

Implements ns3::NetDevice.

virtual Ptr<Node> ns3::VirtualNetDevice::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.

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

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

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

  • /NodeList/[i]/DeviceList/[i]/$ns3::VirtualNetDevice
No Attributes defined for this type.
Attributes defined in parent class ns3::NetDevice:
  • Mtu: The MAC-level Maximum Transmission Unit
TraceSources defined for this type:
  • MacTx: Trace source indicating a packet has arrived for transmission by this device
  • MacPromiscRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a promiscuous trace,
  • MacRx: A packet has been received by this device, has been passed up from the physical layer and is being forwarded up the local protocol stack. This is a non-promiscuous trace,
  • Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
  • PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device

Reimplemented from ns3::NetDevice.

virtual bool ns3::VirtualNetDevice::IsBridge ( void   )  const [virtual]

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

Returns:
value of m_isBridge flag

Implements ns3::NetDevice.

virtual bool ns3::VirtualNetDevice::IsBroadcast ( void   )  const [virtual]

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

Implements ns3::NetDevice.

virtual bool ns3::VirtualNetDevice::IsLinkUp ( void   )  const [virtual]

Returns:
true if link is up; false otherwise

Implements ns3::NetDevice.

virtual bool ns3::VirtualNetDevice::IsMulticast ( void   )  const [virtual]

Returns:
value of m_isMulticast flag

Implements ns3::NetDevice.

virtual bool ns3::VirtualNetDevice::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.

virtual bool ns3::VirtualNetDevice::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::VirtualNetDevice::Receive ( Ptr< Packet >  packet,
uint16_t  protocol,
const Address &  source,
const Address &  destination,
PacketType  packetType 
)

Parameters:
packet packet sent from below up to Network Device
protocol Protocol type
source the address of the sender of this packet.
destination the address of the receiver of this packet.
packetType type of packet received (broadcast/multicast/unicast/otherhost)
Returns:
true if the packet was forwarded successfully, false otherwise.
Forward a "virtually received" packet up the node's protocol stack.

virtual bool ns3::VirtualNetDevice::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::VirtualNetDevice::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.

virtual void ns3::VirtualNetDevice::SetAddress ( Address  address  )  [virtual]

Set the address of this interface

Implements ns3::NetDevice.

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

Parameters:
index ifIndex of the device

Implements ns3::NetDevice.

void ns3::VirtualNetDevice::SetIsPointToPoint ( bool  isPointToPoint  ) 

Configure whether the virtual device is point-to-point.

Parameters:
isPointToPoint the value that should be returned by the IsPointToPoint method for this instance.

virtual void ns3::VirtualNetDevice::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.

bool ns3::VirtualNetDevice::SetMtu ( const uint16_t  mtu  )  [virtual]

Configure the reported MTU for the virtual device. The default value is 65535.

Returns:
whether the MTU value was within legal bounds

Implements ns3::NetDevice.

void ns3::VirtualNetDevice::SetNeedsArp ( bool  needsArp  ) 

Configure whether the virtual device needs ARP.

Parameters:
needsArp the the 'needs arp' value that will be returned by the NeedsArp() method. The method IsBroadcast() will also return this value.

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

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

Implements ns3::NetDevice.

virtual void ns3::VirtualNetDevice::SetPromiscReceiveCallback ( NetDevice::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::VirtualNetDevice::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::VirtualNetDevice::SetSendCallback ( SendCallback  transmitCb  ) 

Set the user callback to be called when a L2 packet is to be transmitted.

Parameters:
transmitCb the new transmit callback

virtual bool ns3::VirtualNetDevice::SupportsSendFrom (  )  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:
Generated on Fri Apr 9 15:01:09 2010 for NS-3 by  doxygen 1.5.8