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

#include "qkd-net-device.h"

Inheritance diagram for ns3::QKDNetDevice:

Collaboration diagram for ns3::QKDNetDevice:

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

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

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

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

Public Member Functions
	QKDNetDevice ()

virtual	~QKDNetDevice ()

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

Ptr< Queue< Packet > >	GetQueue (void) const
	Get a copy of the attached Queue. More...

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	IsReady (void) const

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)
	Set the address of this interface. More...

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)

void	SetQueue (Ptr< Queue< Packet > > queue)
	Attach a queue to the PointToPointNetDevice. More...

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. More...

virtual bool	SupportsSendFrom () const

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

virtual void	SetSniffPacketFromDevice (bool value)

virtual bool	ShouldSniffPacketFromDevice ()

virtual void	SniffPacket (Ptr< const Packet > p)

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

virtual	~Object ()
	Destructor. More...

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

void	Dispose (void)
	Dispose of this Object. More...

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

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

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

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

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

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

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

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

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static TypeId	GetTypeId (void)

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

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

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

Protected Member Functions
virtual void	DoDispose (void)
	Destructor implementation. More...

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

virtual void	DoInitialize (void)
	Initialize() implementation. More...

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

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

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

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_macTxDropTrace
	The trace source fired when packets coming into the "top" of the device at the L3/L2 transition are dropped before being queued for transmission. More...

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

Ptr< Queue< Packet > >	m_queue
	The Queue which this PointToPointNetDevice uses as a packet source. More...

ReceiveCallback	m_rxCallback

SendCallback	m_sendCb

TracedCallback< Ptr< const Packet > >	m_snifferTrace

bool	m_supportsSendFrom

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

Detailed Description

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

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::QKDNetDevice"

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
TxQueue: A queue to use as the transmit queue in the device.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::Queue<Packet>>
- Initial value: 0
- Flags: construct write read

TraceSources

MacTx: Trace source indicating a packet has arrived for transmission by this device
Callback signature: ns3::QKDNetDevice::MacTx
MacTxDrop: Trace source indicating a packet has been dropped by the device before transmission
Callback signature: ns3::Packet::MacTxDrop
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,
Callback signature: ns3::QKDNetDevice::MacPromiscRx
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,
Callback signature: ns3::QKDNetDevice::MacRx
Sniffer: Trace source simulating a non-promiscuous packet sniffer attached to the device
Callback signature: ns3::QKDNetDevice::Sniffer
PromiscSniffer: Trace source simulating a promiscuous packet sniffer attached to the device
Callback signature: ns3::QKDNetDevice::PromiscSniffer

Size of this type is 288 bytes (on a 64-bit architecture).

A QKDNetDevice 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 QKDNetDevice. 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, QKDNetDevice is usually much simpler to program than a NetDevice subclass.

Note: QKDNetDevices are used only for overlay implementation of the QKD network.

Definition at line 60 of file qkd-net-device.h.

Member Typedef Documentation

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

Callback the be invoked when the QKDNetDevice is asked to queue/transmit a packet.

For more information, consult the documentation of NetDevice::SendFrom().

Definition at line 67 of file qkd-net-device.h.

Constructor & Destructor Documentation

ns3::QKDNetDevice::QKDNetDevice ( )

Definition at line 94 of file qkd-net-device.cc.

References m_isPointToPoint, m_needsArp, and m_supportsSendFrom.

ns3::QKDNetDevice::~QKDNetDevice ( )

virtual

Definition at line 134 of file qkd-net-device.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void ns3::QKDNetDevice::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::QKDNetDevice::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