This class implements a device which does not communicate, in the sense that it does not interact with the above protocol stack. More...
#include "non-communicating-net-device.h"
Public Member Functions | |
NonCommunicatingNetDevice () | |
~NonCommunicatingNetDevice () override | |
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 addr) 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 |
Ptr< Object > | GetPhy () const |
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 | SetChannel (Ptr< Channel > c) |
This class doesn't talk directly with the underlying channel (a dedicated PHY class is expected to do it), however the NetDevice specification features a GetChannel() method. More... | |
void | SetIfIndex (const uint32_t index) override |
bool | SetMtu (const uint16_t mtu) override |
void | SetNode (Ptr< Node > node) override |
void | SetPhy (Ptr< Object > phy) |
Set the Phy object which is attached to this device. More... | |
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... | |
Private Member Functions | |
void | DoDispose () override |
Destructor implementation. More... | |
Private Attributes | |
Ptr< Channel > | m_channel |
Channel used by the NetDevice. More... | |
uint32_t | m_ifIndex |
Interface index. More... | |
Ptr< Node > | m_node |
node this NetDevice is associated to More... | |
Ptr< Object > | m_phy |
Phy object. 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 |
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... | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
This class implements a device which does not communicate, in the sense that it does not interact with the above protocol stack.
The purpose of this NetDevice is to be used for devices such as microwave ovens, waveform generators and spectrum analyzers. Since the ns-3 channel API is strongly based on the presence of NetDevice class instances, it is convenient to provide a NetDevice that can be used with such non-communicating devices.
Definition at line 51 of file non-communicating-net-device.h.
ns3::NonCommunicatingNetDevice::NonCommunicatingNetDevice | ( | ) |
Definition at line 53 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 58 of file non-communicating-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 221 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overrideprivatevirtual |
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 64 of file non-communicating-net-device.cc.
References ns3::Object::DoDispose(), m_channel, m_node, m_phy, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 108 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 122 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
Implements ns3::NetDevice.
Definition at line 200 of file non-communicating-net-device.cc.
References m_channel, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 81 of file non-communicating-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
|
overridevirtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 95 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
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 136 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 143 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
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 164 of file non-communicating-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Definition at line 186 of file non-communicating-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
static |
Get the type ID.
Definition at line 38 of file non-communicating-net-device.cc.
References GetPhy(), ns3::MakePointerAccessor(), ns3::TypeId::SetParent(), and SetPhy().
|
overridevirtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 157 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 115 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 214 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 129 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 150 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 207 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
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 246 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
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 253 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 102 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
This class doesn't talk directly with the underlying channel (a dedicated PHY class is expected to do it), however the NetDevice specification features a GetChannel() method.
This method here is therefore provide to allow NonCommunicatingNetDevice::GetChannel() to have something meaningful to return.
c | the underlying channel |
Definition at line 193 of file non-communicating-net-device.cc.
References m_channel, and NS_LOG_FUNCTION.
|
overridevirtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 74 of file non-communicating-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
|
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 88 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 171 of file non-communicating-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Set the Phy object which is attached to this device.
This object is needed so that we can set/get attributes and connect to trace sources of the PHY from the net device.
phy | the Phy object embedded within this device. |
Definition at line 179 of file non-communicating-net-device.cc.
References m_phy, NS_LOG_FUNCTION, and third::phy.
Referenced by GetTypeId().
|
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 233 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
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 227 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 239 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
Channel used by the NetDevice.
Definition at line 121 of file non-communicating-net-device.h.
Referenced by DoDispose(), GetChannel(), and SetChannel().
|
private |
Interface index.
Definition at line 122 of file non-communicating-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
node this NetDevice is associated to
Definition at line 120 of file non-communicating-net-device.h.
Referenced by DoDispose(), GetNode(), and SetNode().
Phy object.
Definition at line 123 of file non-communicating-net-device.h.
Referenced by DoDispose(), GetPhy(), and SetPhy().