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 () | |
virtual | ~NonCommunicatingNetDevice () |
virtual void | AddLinkChangeCallback (Callback< void > callback) |
virtual Address | GetAddress (void) const |
virtual Address | GetBroadcast (void) const |
virtual Ptr< Channel > | GetChannel (void) const |
virtual uint32_t | GetIfIndex (void) const |
virtual uint16_t | GetMtu (void) const |
virtual Address | GetMulticast (Ipv4Address addr) const |
Make and return a MAC multicast address using the provided multicast group. More... | |
virtual Address | GetMulticast (Ipv6Address addr) const |
Get the MAC multicast address corresponding to the IPv6 address provided. More... | |
virtual Ptr< Node > | GetNode (void) const |
Ptr< Object > | GetPhy () const |
virtual bool | IsBridge (void) const |
Return true if the net device is acting as a bridge. More... | |
virtual bool | IsBroadcast (void) const |
virtual bool | IsLinkUp (void) const |
virtual bool | IsMulticast (void) const |
virtual bool | IsPointToPoint (void) const |
Return true if the net device is on a point-to-point link. More... | |
virtual bool | NeedsArp (void) const |
virtual bool | Send (Ptr< Packet > packet, const Address &dest, uint16_t protocolNumber) |
virtual bool | SendFrom (Ptr< Packet > packet, const Address &source, const Address &dest, uint16_t protocolNumber) |
virtual void | SetAddress (Address address) |
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... | |
virtual void | SetIfIndex (const uint32_t index) |
virtual bool | SetMtu (const uint16_t mtu) |
virtual void | SetNode (Ptr< Node > node) |
void | SetPhy (Ptr< Object > phy) |
Set the Phy object which is attached to this device. More... | |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) |
virtual void | SetReceiveCallback (NetDevice::ReceiveCallback cb) |
virtual bool | SupportsSendFrom (void) const |
![]() | |
virtual | ~NetDevice () |
![]() | |
Object () | |
virtual | ~Object () |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
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) |
This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
![]() | |
SimpleRefCount () | |
Constructor. More... | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
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 TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Member Functions | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
Private Attributes | |
Ptr< Channel > | m_channel |
uint32_t | m_ifIndex |
Ptr< Node > | m_node |
Ptr< Object > | m_phy |
Additional Inherited Members | |
![]() | |
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 PacketType > | PromiscReceiveCallback |
typedef Callback< bool, Ptr < NetDevice >, Ptr< const Packet >, uint16_t, const Address & > | ReceiveCallback |
![]() | |
Object (const Object &o) | |
virtual void | DoInitialize (void) |
This method is called only once by Object::Initialize. More... | |
virtual void | NotifyNewAggregate (void) |
This method is invoked whenever two sets of objects are aggregated together. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. 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.
ns3::NonCommunicatingNetDevice is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Definition at line 54 of file non-communicating-net-device.h.
ns3::NonCommunicatingNetDevice::NonCommunicatingNetDevice | ( | ) |
Definition at line 56 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Definition at line 61 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
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 229 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
privatevirtual |
This method is called by Object::Dispose or by the object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overriden 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 67 of file non-communicating-net-device.cc.
References ns3::Object::DoDispose(), m_channel, m_node, m_phy, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 112 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 126 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
Implements ns3::NetDevice.
Definition at line 207 of file non-communicating-net-device.cc.
References m_channel, and NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 85 of file non-communicating-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
|
virtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 99 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
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.
multicastGroup | The IP address for the multicast group destination of the packet. |
Implements ns3::NetDevice.
Definition at line 140 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 147 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 169 of file non-communicating-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Definition at line 192 of file non-communicating-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
static |
Definition at line 42 of file non-communicating-net-device.cc.
References GetPhy(), ns3::TypeId::SetParent(), and SetPhy().
|
virtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 161 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 119 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 222 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 133 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 154 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 215 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
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 255 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
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 262 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 106 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 200 of file non-communicating-net-device.cc.
References m_channel, and NS_LOG_FUNCTION.
|
virtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 78 of file non-communicating-net-device.cc.
References m_ifIndex, and NS_LOG_FUNCTION.
|
virtual |
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 92 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 176 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 184 of file non-communicating-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
virtual |
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 241 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
cb | callback to invoke whenever a packet has been received and must be forwarded to the higher layers. |
Implements ns3::NetDevice.
Definition at line 235 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
|
virtual |
Implements ns3::NetDevice.
Definition at line 247 of file non-communicating-net-device.cc.
References NS_LOG_FUNCTION.
Definition at line 127 of file non-communicating-net-device.h.
Referenced by DoDispose(), GetChannel(), and SetChannel().
|
private |
Definition at line 129 of file non-communicating-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
Definition at line 126 of file non-communicating-net-device.h.
Referenced by DoDispose(), GetNode(), and SetNode().
Definition at line 131 of file non-communicating-net-device.h.
Referenced by DoDispose(), GetPhy(), and SetPhy().