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

#include <introspected-doxygen.h>

Inheritance diagram for ns3::VirtualNetDevice:

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

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 &, const Address &, enum PacketType >	PromiscReceiveCallback

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

Public Member Functions
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

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

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

bool	Receive (Ptr< Packet > packet, uint16_t protocol, const Address &source, const Address &destination, PacketType packetType)

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)

virtual void	SetIfIndex (const uint32_t index)

void	SetIsPointToPoint (bool isPointToPoint)
	Configure whether the virtual device is point-to-point. More...

bool	SetMtu (const uint16_t mtu)
	Configure the reported MTU for the virtual device. More...

void	SetNeedsArp (bool needsArp)
	Configure whether the virtual device needs ARP. More...

virtual void	SetNode (Ptr< Node > node)

virtual void	SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb)

virtual void	SetReceiveCallback (NetDevice::ReceiveCallback cb)

void	SetSendCallback (SendCallback transmitCb)
	Set the user callback to be called when a L2 packet is to be transmitted. More...

void	SetSupportsSendFrom (bool supportsSendFrom)
	Configure whether the virtual device supports SendFrom.

virtual bool	SupportsSendFrom () const

Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

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)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
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)

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

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

Protected Member Functions
virtual void	DoDispose (void)

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

virtual void	DoInitialize (void)

virtual void	NotifyNewAggregate (void)

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

virtual void	NotifyConstructionCompleted (void)

Private Attributes
uint32_t	m_index

bool	m_isPointToPoint

TracedCallback< Ptr< const Packet > >	m_macPromiscRxTrace

TracedCallback< Ptr< const Packet > >	m_macRxTrace

TracedCallback< Ptr< const Packet > >	m_macTxTrace

uint16_t	m_mtu

Address	m_myAddress

std::string	m_name

bool	m_needsArp

Ptr< Node >	m_node

PromiscReceiveCallback	m_promiscRxCallback

TracedCallback< Ptr< const Packet > >	m_promiscSnifferTrace

ReceiveCallback	m_rxCallback

SendCallback	m_sendCb

TracedCallback< Ptr< const Packet > >	m_snifferTrace

bool	m_supportsSendFrom

Detailed Description

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

Config Paths

ns3::VirtualNetDevice is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]/$ns3::VirtualNetDevice

Attributes

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

TraceSources

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

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.

Definition at line 58 of file virtual-net-device.h.

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

Definition at line 65 of file virtual-net-device.h.

Member Function Documentation

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

bool ns3::VirtualNetDevice::Receive	(	Ptr< Packet >	packet,
		uint16_t	protocol,
		const Address &	source,
		const Address &	destination,
		PacketType	packetType
	)

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)

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.

Public Types

Public Member Functions

Static Public Member Functions