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

#include "virtual-net-device.h"

Inheritance diagram for ns3::VirtualNetDevice:

Collaboration diagram for ns3::VirtualNetDevice:

Public Types
typedef Callback< bool, Ptr< Packet >, const Address &, const Address &, uint16_t >	SendCallback
	Callback the be invoked when the VirtualNetDevice is asked to queue/transmit a packet.

Public Types inherited from ns3::NetDevice
typedef void(*	LinkChangeTracedCallback) ()
	TracedCallback signature for link changed event.

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 }
	Packet types are used as they are in Linux. More...

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

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

Public Member Functions
	VirtualNetDevice ()

	~VirtualNetDevice () override

void	AddLinkChangeCallback (Callback< void > callback) override

Address	GetAddress () const override

Address	GetBroadcast () const override

Ptr< Channel >	GetChannel () const override

uint32_t	GetIfIndex () const override

uint16_t	GetMtu () const override

Address	GetMulticast (Ipv4Address multicastGroup) const override
	Make and return a MAC multicast address using the provided multicast group.

Address	GetMulticast (Ipv6Address addr) const override
	Get the MAC multicast address corresponding to the IPv6 address provided.

Ptr< Node >	GetNode () const override

bool	IsBridge () const override
	Return true if the net device is acting as a bridge.

bool	IsBroadcast () const override

bool	IsLinkUp () const override

bool	IsMulticast () const override

bool	IsPointToPoint () const override
	Return true if the net device is on a point-to-point link.

bool	NeedsArp () const override

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

bool	Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) override

bool	SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) override

void	SetAddress (Address address) override
	Set the address of this interface.

void	SetIfIndex (const uint32_t index) override

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

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

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

void	SetNode (Ptr< Node > node) override

void	SetPromiscReceiveCallback (NetDevice::PromiscReceiveCallback cb) override

void	SetReceiveCallback (NetDevice::ReceiveCallback cb) override

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

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

bool	SupportsSendFrom () const override

Public Member Functions inherited from ns3::NetDevice
	~NetDevice () override

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::NetDevice
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

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

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Private Attributes
uint32_t	m_index
	Device index.

bool	m_isPointToPoint
	True if the device is a PointToPoint type device.

TracedCallback< Ptr< const Packet > >	m_macPromiscRxTrace
	Promisc Rx trace.

TracedCallback< Ptr< const Packet > >	m_macRxTrace
	Rx trace.

TracedCallback< Ptr< const Packet > >	m_macTxTrace
	Tx trace.

uint16_t	m_mtu
	MTU.

Address	m_myAddress
	MAC address.

std::string	m_name
	Name of the device.

bool	m_needsArp
	True if the device needs ARP.

Ptr< Node >	m_node
	Pointer to the node.

PromiscReceiveCallback	m_promiscRxCallback
	Promisc Rx callback.

TracedCallback< Ptr< const Packet > >	m_promiscSnifferTrace
	Promisc Sniffer trace.

ReceiveCallback	m_rxCallback
	Rx callback.

SendCallback	m_sendCb
	send callback

TracedCallback< Ptr< const Packet > >	m_snifferTrace
	Sniffer trace.

bool	m_supportsSendFrom
	True if the device supports SendFrm.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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.

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

Member Typedef Documentation

◆ SendCallback

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 53 of file virtual-net-device.h.

Constructor & Destructor Documentation

◆ VirtualNetDevice()

ns3::VirtualNetDevice::VirtualNetDevice ( )

Definition at line 76 of file virtual-net-device.cc.

References m_isPointToPoint, m_needsArp, and m_supportsSendFrom.

◆ ~VirtualNetDevice()

ns3::VirtualNetDevice::~VirtualNetDevice ( )

override

Definition at line 114 of file virtual-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ AddLinkChangeCallback()

void ns3::VirtualNetDevice::AddLinkChangeCallback ( Callback< void > callback )

overridevirtual

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

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SendCallback

Constructor & Destructor Documentation

◆ VirtualNetDevice()

◆ ~VirtualNetDevice()

Member Function Documentation

◆ AddLinkChangeCallback()

◆ DoDispose()

◆ GetAddress()

◆ GetBroadcast()

◆ GetChannel()

◆ GetIfIndex()

◆ GetMtu()

◆ GetMulticast() [1/2]

◆ GetMulticast() [2/2]

◆ GetNode()

◆ GetTypeId()

◆ IsBridge()

◆ IsBroadcast()

◆ IsLinkUp()

◆ IsMulticast()

◆ IsPointToPoint()

◆ NeedsArp()

◆ Receive()

◆ Send()

◆ SendFrom()

◆ SetAddress()

◆ SetIfIndex()

◆ SetIsPointToPoint()

◆ SetMtu()

◆ SetNeedsArp()

◆ SetNode()

◆ SetPromiscReceiveCallback()

◆ SetReceiveCallback()

◆ SetSendCallback()

◆ SetSupportsSendFrom()

◆ SupportsSendFrom()

Member Data Documentation

◆ m_index

◆ m_isPointToPoint

◆ m_macPromiscRxTrace

◆ m_macRxTrace

◆ m_macTxTrace

◆ m_mtu

◆ m_myAddress

◆ m_name

◆ m_needsArp

◆ m_node

◆ m_promiscRxCallback

◆ m_promiscSnifferTrace

◆ m_rxCallback

◆ m_sendCb

◆ m_snifferTrace

◆ m_supportsSendFrom