Virtual network interface that loops back any data sent to it to be immediately received on the same interface. More...
#include "loopback-net-device.h"
Public Member Functions | |
LoopbackNetDevice () | |
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. More... | |
Address | GetMulticast (Ipv6Address addr) const override |
Get the MAC multicast address corresponding to the IPv6 address provided. More... | |
Ptr< Node > | GetNode () const override |
bool | IsBridge () const override |
Return true if the net device is acting as a bridge. More... | |
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. More... | |
bool | NeedsArp () const override |
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. More... | |
void | SetIfIndex (const uint32_t index) override |
bool | SetMtu (const uint16_t mtu) override |
void | SetNode (Ptr< Node > node) override |
void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) override |
void | SetReceiveCallback (NetDevice::ReceiveCallback cb) override |
bool | SupportsSendFrom () const override |
Public Member Functions inherited from ns3::NetDevice | |
~NetDevice () override | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. More... | |
~Object () override | |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose () |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. More... | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. More... | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized () 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[[maybe_unused]]) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o[[maybe_unused]]) |
Assignment operator. More... | |
void | Ref () const |
Increment the reference count. More... | |
void | Unref () 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 errors. 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 () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::NetDevice | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. More... | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. More... | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoInitialize () |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate () |
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 () |
Notifier called once the ObjectBase is fully constructed. More... | |
Private Member Functions | |
void | Receive (Ptr< Packet > packet, uint16_t protocol, Mac48Address to, Mac48Address from) |
Receive a packet from tge Loopback NetDevice. More... | |
Private Attributes | |
Mac48Address | m_address |
NetDevice MAC address. More... | |
uint32_t | m_ifIndex |
interface index More... | |
uint16_t | m_mtu |
device MTU More... | |
Ptr< Node > | m_node |
the node this NetDevice is associated with More... | |
NetDevice::PromiscReceiveCallback | m_promiscCallback |
The callback used to notify higher layers that a packet has been received in promiscuous mode. More... | |
NetDevice::ReceiveCallback | m_rxCallback |
The callback used to notify higher layers that a packet has been received. More... | |
Additional Inherited Members | |
Public Types inherited from ns3::NetDevice | |
typedef void(* | LinkChangeTracedCallback) () |
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 &, PacketType > | PromiscReceiveCallback |
typedef Callback< bool, Ptr< NetDevice >, Ptr< const Packet >, uint16_t, const Address & > | ReceiveCallback |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Virtual network interface that loops back any data sent to it to be immediately received on the same interface.
This NetDevice is automatically added to any node as soon as the Internet stack is initialized.
Definition at line 43 of file loopback-net-device.h.
ns3::LoopbackNetDevice::LoopbackNetDevice | ( | ) |
Definition at line 44 of file loopback-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
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.
Implements ns3::NetDevice.
Definition at line 134 of file loopback-net-device.cc.
|
overrideprotectedvirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.
It is safe to call GetObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 246 of file loopback-net-device.cc.
References ns3::Object::DoDispose(), and m_node.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 109 of file loopback-net-device.cc.
References m_address.
|
overridevirtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 145 of file loopback-net-device.cc.
Referenced by Send().
Implements ns3::NetDevice.
Definition at line 97 of file loopback-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 91 of file loopback-net-device.cc.
References m_ifIndex.
|
overridevirtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 122 of file loopback-net-device.cc.
References m_mtu.
|
overridevirtual |
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.
multicastGroup | The IP address for the multicast group destination of the packet. |
Implements ns3::NetDevice.
Definition at line 160 of file loopback-net-device.cc.
References ns3::Mac48Address::GetMulticast().
|
overridevirtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 166 of file loopback-net-device.cc.
References ns3::Mac48Address::GetMulticast().
When a subclass needs to get access to the underlying node base class to print the nodeid for example, it can invoke this method.
Implements ns3::NetDevice.
Definition at line 222 of file loopback-net-device.cc.
References m_node.
|
static |
Get the type ID.
Definition at line 35 of file loopback-net-device.cc.
References ns3::TypeId::SetParent().
|
overridevirtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 178 of file loopback-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 139 of file loopback-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 128 of file loopback-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 152 of file loopback-net-device.cc.
|
overridevirtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 172 of file loopback-net-device.cc.
|
overridevirtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 234 of file loopback-net-device.cc.
|
private |
Receive a packet from tge Loopback NetDevice.
packet | a reference to the received packet |
protocol | the protocol |
to | destination address |
from | source address |
Definition at line 54 of file loopback-net-device.cc.
References ns3::Mac48Address::IsBroadcast(), ns3::Mac48Address::IsGroup(), ns3::Callback< R, UArgs >::IsNull(), m_address, m_promiscCallback, m_rxCallback, NS_LOG_FUNCTION, ns3::NetDevice::PACKET_HOST, ns3::NetDevice::PACKET_MULTICAST, and ns3::NetDevice::PACKET_OTHERHOST.
Referenced by Send(), and SendFrom().
|
overridevirtual |
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
Implements ns3::NetDevice.
Definition at line 184 of file loopback-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), GetBroadcast(), ns3::Node::GetId(), m_address, m_node, NS_ASSERT_MSG, NS_LOG_FUNCTION, Receive(), ns3::Simulator::ScheduleWithContext(), and ns3::Seconds().
|
overridevirtual |
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.
Implements ns3::NetDevice.
Definition at line 201 of file loopback-net-device.cc.
References ns3::Mac48Address::ConvertFrom(), ns3::Node::GetId(), ns3::Mac48Address::IsBroadcast(), m_address, m_node, NS_ASSERT_MSG, NS_LOG_FUNCTION, Receive(), ns3::Simulator::ScheduleWithContext(), and ns3::Seconds().
|
overridevirtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 103 of file loopback-net-device.cc.
References first::address, ns3::Mac48Address::ConvertFrom(), and m_address.
|
overridevirtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 85 of file loopback-net-device.cc.
References m_ifIndex.
|
overridevirtual |
mtu | MTU value, in bytes, to set for the device |
Override for default MTU defined on a per-type basis.
Implements ns3::NetDevice.
Definition at line 115 of file loopback-net-device.cc.
References m_mtu.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 228 of file loopback-net-device.cc.
References m_node.
|
overridevirtual |
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.
Implements ns3::NetDevice.
Definition at line 253 of file loopback-net-device.cc.
References m_promiscCallback.
|
overridevirtual |
cb | callback 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.
Implements ns3::NetDevice.
Definition at line 240 of file loopback-net-device.cc.
References m_rxCallback.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 259 of file loopback-net-device.cc.
|
private |
NetDevice MAC address.
Definition at line 112 of file loopback-net-device.h.
Referenced by GetAddress(), Receive(), Send(), SendFrom(), and SetAddress().
|
private |
interface index
Definition at line 111 of file loopback-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
device MTU
Definition at line 110 of file loopback-net-device.h.
the node this NetDevice is associated with
Definition at line 109 of file loopback-net-device.h.
Referenced by DoDispose(), GetNode(), Send(), SendFrom(), and SetNode().
|
private |
The callback used to notify higher layers that a packet has been received in promiscuous mode.
Definition at line 107 of file loopback-net-device.h.
Referenced by Receive(), and SetPromiscReceiveCallback().
|
private |
The callback used to notify higher layers that a packet has been received.
Definition at line 101 of file loopback-net-device.h.
Referenced by Receive(), and SetReceiveCallback().