Network layer to device interface. More...

#include <net-device.h>

Inheritance diagram for ns3::NetDevice:

Collaboration diagram for ns3::NetDevice:

Public Types
enum	PacketType
typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address & >	ReceiveCallback
typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address &, const Address &, enum PacketType >	PromiscReceiveCallback
Public Member Functions
virtual void	SetName (const std::string name)=0
virtual std::string	GetName (void) const =0
virtual void	SetIfIndex (const uint32_t index)=0
virtual uint32_t	GetIfIndex (void) const =0
virtual Ptr< Channel >	GetChannel (void) const =0
virtual Address	GetAddress (void) const =0
virtual bool	SetMtu (const uint16_t mtu)=0
virtual uint16_t	GetMtu (void) const =0
virtual bool	IsLinkUp (void) const =0
virtual void	SetLinkChangeCallback (Callback< void > callback)=0
virtual bool	IsBroadcast (void) const =0
virtual Address	GetBroadcast (void) const =0
virtual bool	IsMulticast (void) const =0
virtual Address	GetMulticast (void) const =0
	Return the MAC multicast base address used when mapping multicast groups to MAC multicast addresses.
virtual Address	MakeMulticastAddress (Ipv4Address multicastGroup) const =0
	Make and return a MAC multicast address using the provided multicast group.
virtual bool	IsPointToPoint (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 Ptr< Node >	GetNode (void) const =0
virtual void	SetNode (Ptr< Node > node)=0
virtual bool	NeedsArp (void) const =0
virtual void	SetReceiveCallback (ReceiveCallback cb)=0
virtual void	SetPromiscReceiveCallback (PromiscReceiveCallback cb)=0
virtual bool	SupportsSendFrom (void) const =0
Static Public Member Functions
static TypeId	GetTypeId (void)
	This method returns the TypeId associated to ns3::NetDevice.

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 NetDevice::SendTo method.

Member Typedef Documentation

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

Parameters:

	device	a pointer to the net device which is calling this callback
	packet	the packet received
	protocol	the 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.
	sender	the address of the sender
	receiver	the address of the receiver
	packetType	type of packet received (broadcast/multicast/unicast/otherhost)

Returns:: true if the callback could handle the packet successfully, false otherwise.

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

Parameters:

	device	a pointer to the net device which is calling this callback
	packet	the packet received
	protocol	the 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.
	sender	the address of the sender

Returns:: true if the callback could handle the packet successfully, false otherwise.

Member Enumeration Documentation

enum ns3::NetDevice::PacketType

Packet types

Member Function Documentation

virtual Address ns3::NetDevice::GetAddress ( void ) const [pure virtual]

Returns:: the current Address of this interface.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual Address ns3::NetDevice::GetBroadcast ( void ) const [pure virtual]

Returns:: the broadcast address supported by this netdevice.

Calling this method is invalid if IsBroadcast returns not true.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

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.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual uint32_t ns3::NetDevice::GetIfIndex ( void ) const [pure virtual]

Returns:: index ifIndex of the device

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

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

Returns:: the link-level MTU in bytes for this interface.

This value is typically used by the IP layer to perform IP fragmentation when needed.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual Address ns3::NetDevice::GetMulticast ( void ) const [pure virtual]

Return the MAC multicast base address used when mapping multicast groups to MAC multicast addresses.

Typically when one constructs a multicast MAC addresses, some bits from the IP multicast group are copied into a corresponding MAC multicast group. In EUI-48, for example, the low order 23 bits of the multicast group are copied to the MAC multicast group base address.

This method allows access to the underlying MAC multicast group base address. It is expected that in most cases, a net device client will allow the net device to perform the actual construction of the multicast address. Use of this method is discouraged unless you have a good reason to perform a custom mapping. You should prefer NetDevice::MakeMulticastAddress which will do the RFC-specified mapping for the net device in question.

Returns:: The multicast address supported by this net device.

Warning:: Calling this method is invalid if IsMulticast returns not true. The method NS_ASSERTs if the device is not a multicast device.

See also:: NetDevice::MakeMulticastAddress

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual std::string ns3::NetDevice::GetName ( void ) const [pure virtual]

Returns:: name name of the device (e.g. "eth0")

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

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::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

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

This method returns the TypeId associated to ns3::NetDevice.

This object is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/DeviceList/[i]

Attributes defined for this type:

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

No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsBroadcast ( void ) const [pure virtual]

Returns:: true if this interface supports a broadcast address, false otherwise.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsLinkUp ( void ) const [pure virtual]

Returns:: true if link is up; false otherwise

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsMulticast ( void ) const [pure virtual]

Returns:: value of m_isMulticast flag

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::IsPointToPoint ( void ) const [pure virtual]

Returns:: value of m_isPointToPoint flag

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual Address ns3::NetDevice::MakeMulticastAddress ( 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.

A default imlementation of MakeMulticastAddress is provided, but this method simply NS_ASSERTS. 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:

multicastGroup

The 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::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::NeedsArp ( void ) const [pure virtual]

Returns:: true if ARP is needed, false otherwise.

Called by higher-layers to check if this NetDevice requires ARP to be used.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::Send	(	Ptr< Packet >	packet,
		const Address &	dest,
		uint16_t	protocolNumber
	)			`[pure virtual]`

Parameters:

	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.

Called from higher layer to send packet into Network Device to the specified destination Address

Returns:: whether the Send operation succeeded

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::SendFrom	(	Ptr< Packet >	packet,
		const Address &	source,
		const Address &	dest,
		uint16_t	protocolNumber
	)			`[pure virtual]`

Parameters:

	packet	packet sent from above down to Network Device
	source	source mac address (so called "MAC spoofing")
	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.

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::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetIfIndex ( const uint32_t index ) [pure virtual]

Parameters:

index

ifIndex of the device

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetLinkChangeCallback ( Callback< void > callback ) [pure virtual]

Parameters:

callback

the callback to invoke

Register 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 whenever the link goes up.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::SetMtu ( const uint16_t mtu ) [pure virtual]

Parameters:

mtu

MTU 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::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetName ( const std::string name ) [pure virtual]

Parameters:

name

name of the device (e.g. "eth0")

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetNode ( Ptr< Node > node ) [pure virtual]

Parameters:

node

the node associated to this netdevice.

This method is called from ns3::Node::AddDevice.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetPromiscReceiveCallback ( PromiscReceiveCallback cb ) [pure virtual]

Parameters:

cb

callback 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::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual void ns3::NetDevice::SetReceiveCallback ( ReceiveCallback cb ) [pure virtual]

Parameters:

cb

callback to invoke whenever a packet has been received and must be forwarded to the higher layers.

Implemented in ns3::BridgeNetDevice, ns3::CsmaNetDevice, ns3::PointToPointNetDevice, ns3::WifiNetDevice, and ns3::SimpleNetDevice.

virtual bool ns3::NetDevice::SupportsSendFrom ( void ) const [pure virtual]