A Discrete-Event Network Simulator
API
ns3::NetDevice Class Referenceabstract

Network layer to device interface. More...

#include "net-device.h"

+ Inheritance diagram for ns3::NetDevice:
+ Collaboration diagram for ns3::NetDevice:

Public Types

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 PacketTypePromiscReceiveCallback
 
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address &> ReceiveCallback
 

Public Member Functions

virtual ~NetDevice ()
 
virtual void AddLinkChangeCallback (Callback< void > callback)=0
 
virtual Address GetAddress (void) const =0
 
virtual Address GetBroadcast (void) const =0
 
virtual Ptr< ChannelGetChannel (void) const =0
 
virtual uint32_t GetIfIndex (void) const =0
 
virtual uint16_t GetMtu (void) const =0
 
virtual Address GetMulticast (Ipv4Address multicastGroup) const =0
 Make and return a MAC multicast address using the provided multicast group. More...
 
virtual Address GetMulticast (Ipv6Address addr) const =0
 Get the MAC multicast address corresponding to the IPv6 address provided. More...
 
virtual Ptr< NodeGetNode (void) const =0
 
virtual bool IsBridge (void) const =0
 Return true if the net device is acting as a bridge. More...
 
virtual bool IsBroadcast (void) const =0
 
virtual bool IsLinkUp (void) const =0
 
virtual bool IsMulticast (void) const =0
 
virtual bool IsPointToPoint (void) const =0
 Return true if the net device is on a point-to-point link. More...
 
virtual bool NeedsArp (void) const =0
 
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 void SetAddress (Address address)=0
 Set the address of this interface. More...
 
virtual void SetIfIndex (const uint32_t index)=0
 
virtual bool SetMtu (const uint16_t mtu)=0
 
virtual void SetNode (Ptr< Node > node)=0
 
virtual void SetPromiscReceiveCallback (PromiscReceiveCallback cb)=0
 
virtual void SetReceiveCallback (ReceiveCallback cb)=0
 
virtual bool SupportsSendFrom (void) const =0
 
- 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...
 
SimpleRefCountoperator= (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)
 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...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. 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...
 

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 pure virtual methods in this class.

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.

Devices aiming to support flow control and dynamic queue limits must perform the following operations:

  • in the NotifyNewAggregate method
    • cache the pointer to the netdevice queue interface aggregated to the device
    • set the select queue callback through the netdevice queue interface, if the device is multi-queue
  • anytime before initialization
    • set the number of device transmission queues (and optionally create them) through the netdevice queue interface, if the device is multi-queue
  • when the device queues have been created, invoke NetDeviceQueueInterface::ConnectQueueTraces, which
    • connects the Enqueue traced callback of the device queues to the PacketEnqueued static method of the NetDeviceQueue class
    • connects the Dequeue and DropAfterDequeue traced callback of the device queues to the PacketDequeued static method of the NetDeviceQueue class
    • connects the DropBeforeEnqueue traced callback of the device queues to the PacketDiscarded static method of the NetDeviceQueue class

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]"

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

Definition at line 95 of file net-device.h.

Member Typedef Documentation

◆ LinkChangeTracedCallback

typedef void(* ns3::NetDevice::LinkChangeTracedCallback) (void)

TracedCallback signature for link changed event.

Definition at line 156 of file net-device.h.

◆ PromiscReceiveCallback

typedef Callback< bool, Ptr<NetDevice>, Ptr<const Packet>, uint16_t, const Address &, const Address &, enum PacketType > ns3::NetDevice::PromiscReceiveCallback
Parameters
devicea pointer to the net device which is calling this callback
packetthe packet received
protocolthe 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.
senderthe address of the sender
receiverthe address of the receiver
packetTypetype of packet received (broadcast/multicast/unicast/otherhost)
Returns
true if the callback could handle the packet successfully, false otherwise.

Definition at line 343 of file net-device.h.

◆ ReceiveCallback

typedef Callback< bool, Ptr<NetDevice>, Ptr<const Packet>, uint16_t, const Address & > ns3::NetDevice::ReceiveCallback
Parameters
devicea pointer to the net device which is calling this callback
packetthe packet received
protocolthe 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.
senderthe address of the sender
Returns
true if the callback could handle the packet successfully, false otherwise.

Definition at line 318 of file net-device.h.

Member Enumeration Documentation

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

NS3_PACKET_HOST 
PACKET_BROADCAST 

Packet addressed to all.

NS3_PACKET_BROADCAST 
PACKET_MULTICAST 

Packet addressed to multicast group.

NS3_PACKET_MULTICAST 
PACKET_OTHERHOST 

Packet addressed to someone else.

NS3_PACKET_OTHERHOST 

Definition at line 296 of file net-device.h.

Constructor & Destructor Documentation

◆ ~NetDevice()

ns3::NetDevice::~NetDevice ( )
virtual

Definition at line 39 of file net-device.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddLinkChangeCallback()

virtual void ns3::NetDevice::AddLinkChangeCallback ( Callback< void >  callback)
pure virtual
Parameters
callbackthe 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.

Implemented in ns3::WimaxNetDevice, ns3::WaveNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::CsmaNetDevice, ns3::TapBridge, ns3::PointToPointNetDevice, ns3::AlohaNoackNetDevice, ns3::FdNetDevice, ns3::UanNetDevice, ns3::VirtualNetDevice, ns3::LrWpanNetDevice, ns3::WifiNetDevice, ns3::BridgeNetDevice, ns3::SimpleNetDevice, ns3::SixLowPanNetDevice, ns3::MeshPointDevice, ns3::NonCommunicatingNetDevice, ns3::LteNetDevice, and ns3::LoopbackNetDevice.

◆ GetAddress()

◆ GetBroadcast()

◆ GetChannel()

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::WaveNetDevice, ns3::WimaxNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::CsmaNetDevice, ns3::TapBridge, ns3::AlohaNoackNetDevice, ns3::PointToPointNetDevice, ns3::FdNetDevice, ns3::UanNetDevice, ns3::VirtualNetDevice, ns3::WifiNetDevice, ns3::BridgeNetDevice, ns3::LrWpanNetDevice, ns3::SimpleNetDevice, ns3::MeshPointDevice, ns3::NonCommunicatingNetDevice, ns3::SixLowPanNetDevice, ns3::LteNetDevice, and ns3::LoopbackNetDevice.

◆ GetIfIndex()

◆ GetMtu()

virtual uint16_t ns3::NetDevice::GetMtu ( void  ) const
pure virtual

◆ GetMulticast() [1/2]

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.

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
multicastGroupThe 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
IsMulticast()

Implemented in ns3::WimaxNetDevice, ns3::WaveNetDevice, ns3::CsmaNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::TapBridge, ns3::AlohaNoackNetDevice, ns3::PointToPointNetDevice, ns3::FdNetDevice, ns3::VirtualNetDevice, ns3::UanNetDevice, ns3::LrWpanNetDevice, ns3::WifiNetDevice, ns3::BridgeNetDevice, ns3::SimpleNetDevice, ns3::NonCommunicatingNetDevice, ns3::SixLowPanNetDevice, ns3::MeshPointDevice, ns3::LteNetDevice, and ns3::LoopbackNetDevice.

◆ GetMulticast() [2/2]

virtual Address ns3::NetDevice::GetMulticast ( Ipv6Address  addr) const
pure virtual

Get the MAC multicast address corresponding to the IPv6 address provided.

Parameters
addrIPv6 address
Returns
the MAC multicast address
Warning
Calling this method is invalid if IsMulticast returns not true.

Implemented in ns3::WimaxNetDevice, ns3::WaveNetDevice, ns3::CsmaNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::TapBridge, ns3::PointToPointNetDevice, ns3::AlohaNoackNetDevice, ns3::FdNetDevice, ns3::VirtualNetDevice, ns3::BridgeNetDevice, ns3::UanNetDevice, ns3::WifiNetDevice, ns3::LrWpanNetDevice, ns3::SimpleNetDevice, ns3::SixLowPanNetDevice, ns3::MeshPointDevice, ns3::NonCommunicatingNetDevice, ns3::LteNetDevice, and ns3::LoopbackNetDevice.

◆ GetNode()

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 30 of file net-device.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsBridge()

◆ IsBroadcast()

◆ IsLinkUp()

◆ IsMulticast()

◆ IsPointToPoint()

◆ NeedsArp()

◆ Send()

virtual bool ns3::NetDevice::Send ( Ptr< Packet packet,
const Address dest,
uint16_t  protocolNumber 
)
pure virtual
Parameters
packetpacket sent from above down to Network Device
destmac address of the destination (already resolved)
protocolNumberidentifies 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::WimaxNetDevice, ns3::WaveNetDevice, ns3::CsmaNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::TapBridge, ns3::PointToPointNetDevice, ns3::AlohaNoackNetDevice, ns3::FdNetDevice, ns3::UanNetDevice, ns3::VirtualNetDevice, ns3::LrWpanNetDevice, ns3::WifiNetDevice, ns3::BridgeNetDevice, ns3::SimpleNetDevice, ns3::SixLowPanNetDevice, ns3::MeshPointDevice, ns3::NonCommunicatingNetDevice, ns3::LteUeNetDevice, ns3::LteEnbNetDevice, ns3::LoopbackNetDevice, and ns3::LteSimpleNetDevice.

Referenced by ns3::SixLowPanNetDevice::ReceiveFromDevice(), SendPacket(), Bug2843TestCase::SendPacketBurst(), and Bug2470TestCase::SendPacketBurst().

+ Here is the caller graph for this function:

◆ SendFrom()

virtual bool ns3::NetDevice::SendFrom ( Ptr< Packet packet,
const Address source,
const Address dest,
uint16_t  protocolNumber 
)
pure virtual
Parameters
packetpacket sent from above down to Network Device
sourcesource mac address (so called "MAC spoofing")
destmac address of the destination (already resolved)
protocolNumberidentifies 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::WimaxNetDevice, ns3::WaveNetDevice, ns3::CsmaNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::TapBridge, ns3::PointToPointNetDevice, ns3::AlohaNoackNetDevice, ns3::FdNetDevice, ns3::UanNetDevice, ns3::VirtualNetDevice, ns3::LrWpanNetDevice, ns3::WifiNetDevice, ns3::BridgeNetDevice, ns3::SimpleNetDevice, ns3::SixLowPanNetDevice, ns3::MeshPointDevice, ns3::NonCommunicatingNetDevice, ns3::LteNetDevice, and ns3::LoopbackNetDevice.

◆ SetAddress()

◆ SetIfIndex()

◆ SetMtu()

virtual bool ns3::NetDevice::SetMtu ( const uint16_t  mtu)
pure virtual
Parameters
mtuMTU 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::WaveNetDevice, ns3::WimaxNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::CsmaNetDevice, ns3::TapBridge, ns3::PointToPointNetDevice, ns3::AlohaNoackNetDevice, ns3::FdNetDevice, ns3::UanNetDevice, ns3::LrWpanNetDevice, ns3::WifiNetDevice, ns3::BridgeNetDevice, ns3::SimpleNetDevice, ns3::VirtualNetDevice, ns3::MeshPointDevice, ns3::NonCommunicatingNetDevice, ns3::SixLowPanNetDevice, ns3::LteNetDevice, and ns3::LoopbackNetDevice.

Referenced by TcFlowControlTestCase::DoRun().

+ Here is the caller graph for this function:

◆ SetNode()

◆ SetPromiscReceiveCallback()

virtual void ns3::NetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback  cb)
pure virtual
Parameters
cbcallback 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::WimaxNetDevice, ns3::WaveNetDevice, ns3::CsmaNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::TapBridge, ns3::PointToPointNetDevice, ns3::AlohaNoackNetDevice, ns3::FdNetDevice, ns3::UanNetDevice, ns3::VirtualNetDevice, ns3::LrWpanNetDevice, ns3::WifiNetDevice, ns3::SimpleNetDevice, ns3::BridgeNetDevice, ns3::SixLowPanNetDevice, ns3::NonCommunicatingNetDevice, ns3::MeshPointDevice, ns3::LteNetDevice, and ns3::LoopbackNetDevice.

◆ SetReceiveCallback()

virtual void ns3::NetDevice::SetReceiveCallback ( ReceiveCallback  cb)
pure virtual
Parameters
cbcallback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Set the callback to be used to notify higher layers when a packet has been received.

Implemented in ns3::WimaxNetDevice, ns3::WaveNetDevice, ns3::CsmaNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::TapBridge, ns3::PointToPointNetDevice, ns3::AlohaNoackNetDevice, ns3::FdNetDevice, ns3::UanNetDevice, ns3::VirtualNetDevice, ns3::LrWpanNetDevice, ns3::WifiNetDevice, ns3::BridgeNetDevice, ns3::SimpleNetDevice, ns3::SixLowPanNetDevice, ns3::NonCommunicatingNetDevice, ns3::MeshPointDevice, ns3::LteNetDevice, and ns3::LoopbackNetDevice.

Referenced by AcousticModemEnergyTestCase::DoRun().

+ Here is the caller graph for this function:

◆ SupportsSendFrom()


The documentation for this class was generated from the following files: