A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ns3::NetDevice Class Referenceabstract

Network layer to device interface. More...

#include <net-device.h>

+ Inheritance diagram for ns3::NetDevice:

Public Types

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)=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
 
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
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
 
SimpleRefCountoperator= (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::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)
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

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.

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.

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

Member Typedef Documentation

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

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

Member Enumeration Documentation

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

PACKET_BROADCAST 

Packet addressed to all

PACKET_MULTICAST 

Packet addressed to multicast group

PACKET_OTHERHOST 

Packet addressed to someone else

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

Member Function Documentation

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

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

virtual uint16_t ns3::NetDevice::GetMtu ( void  ) const
pure virtual
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
Ipv4Address
Address
NetDevice::IsMulticast

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

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

virtual Ptr<Node> ns3::NetDevice::GetNode ( void  ) const
pure 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.

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

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::CsmaNetDevice, ns3::OpenFlowSwitchNetDevice, ns3::WimaxNetDevice, ns3::TapBridge, ns3::EmuNetDevice, ns3::PointToPointNetDevice, ns3::AlohaNoackNetDevice, ns3::FdNetDevice, ns3::VirtualNetDevice, ns3::UanNetDevice, ns3::BridgeNetDevice, ns3::MeshPointDevice, ns3::NonCommunicatingNetDevice, ns3::WifiNetDevice, ns3::ErrorNetDevice, ns3::SimpleNetDevice, ns3::LteUeNetDevice, ns3::LteEnbNetDevice, ns3::LoopbackNetDevice, and ns3::LteSimpleNetDevice.

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

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


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