Net device for UAN models. More...
#include "uan-net-device.h"
Public Types | |
typedef void(* | RxTxTracedCallback) (Ptr< const Packet > packet, Mac8Address address) |
TracedCallback signature for MAC send/receive events. | |
typedef std::list< Ptr< UanPhy > > | UanPhyList |
List of UanPhy objects. | |
typedef std::list< Ptr< UanTransducer > > | UanTransducerList |
List of UanTransducer objects. | |
Public Types inherited from ns3::NetDevice | |
typedef void(* | LinkChangeTracedCallback) () |
TracedCallback signature for link changed event. | |
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 |
Public Member Functions | |
UanNetDevice () | |
Default constructor. | |
~UanNetDevice () override | |
Dummy destructor, DoDispose. | |
void | AddLinkChangeCallback (Callback< void > callback) override |
void | Clear () |
Clear all pointer references. | |
Address | GetAddress () const override |
Address | GetBroadcast () const override |
Ptr< Channel > | GetChannel () const override |
uint32_t | GetIfIndex () const override |
Ptr< UanMac > | GetMac () const |
Get the MAC used by this device. | |
uint16_t | GetMtu () const override |
Address | GetMulticast (Ipv4Address multicastGroup) const override |
Make and return a MAC multicast address using the provided multicast group. | |
Address | GetMulticast (Ipv6Address addr) const override |
Get the MAC multicast address corresponding to the IPv6 address provided. | |
Ptr< Node > | GetNode () const override |
Ptr< UanPhy > | GetPhy () const |
Get the Phy used by this device. | |
Ptr< UanTransducer > | GetTransducer () const |
Get the transducer associated with this device. | |
uint32_t | GetTxModeIndex () |
Get the Tx mode index (Modulation type). | |
bool | IsBridge () const override |
Return true if the net device is acting as a bridge. | |
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. | |
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. | |
void | SetChannel (Ptr< UanChannel > channel) |
Attach a channel. | |
void | SetIfIndex (const uint32_t index) override |
void | SetMac (Ptr< UanMac > mac) |
Set the MAC layer for this device. | |
bool | SetMtu (const uint16_t mtu) override |
void | SetNode (Ptr< Node > node) override |
void | SetPhy (Ptr< UanPhy > phy) |
Set the Phy layer for this device. | |
void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) override |
void | SetReceiveCallback (NetDevice::ReceiveCallback cb) override |
void | SetSleepMode (bool sleep) |
Set the Phy SLEEP mode. | |
void | SetTransducer (Ptr< UanTransducer > trans) |
Set the transdcuer used by this device. | |
void | SetTxModeIndex (uint32_t txModeIndex) |
Set the Tx mode index (Modulation type). | |
bool | SupportsSendFrom () const override |
Public Member Functions inherited from ns3::NetDevice | |
~NetDevice () override | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::NetDevice | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Protected Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
void | DoInitialize () override |
Initialize() implementation. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Private Member Functions | |
Ptr< UanChannel > | DoGetChannel () const |
virtual void | ForwardUp (Ptr< Packet > pkt, uint16_t protocolNumber, const Mac8Address &src) |
Forward the packet to a higher level, set with SetReceiveCallback. | |
Private Attributes | |
Ptr< UanChannel > | m_channel |
The channel attached to this device. | |
bool | m_cleared |
Flag when we've been cleared. | |
ReceiveCallback | m_forwardUp |
The receive callback. | |
uint32_t | m_ifIndex |
The interface index of this device. | |
TracedCallback | m_linkChanges |
Callback to invoke when the link state changes to UP. | |
bool | m_linkup |
The link state, true if up. | |
Ptr< UanMac > | m_mac |
The MAC layer attached to this device. | |
uint16_t | m_mtu |
The device MTU value, in bytes. | |
Ptr< Node > | m_node |
The node hosting this device. | |
Ptr< UanPhy > | m_phy |
The PHY layer attached to this device. | |
TracedCallback< Ptr< const Packet >, Mac8Address > | m_rxLogger |
Trace source triggered when forwarding up received payload from the MAC layer. | |
Ptr< UanTransducer > | m_trans |
The Transducer attached to this device. | |
TracedCallback< Ptr< const Packet >, Mac8Address > | m_txLogger |
Trace source triggered when sending to the MAC layer. | |
Additional Inherited Members | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Net device for UAN models.
ns3::UanNetDevice is accessible through the following paths with Config::Set and Config::Connect:
Group: Uan
Size of this type is 192 bytes (on a 64-bit architecture).
Definition at line 38 of file uan-net-device.h.
typedef void(* ns3::UanNetDevice::RxTxTracedCallback) (Ptr< const Packet > packet, Mac8Address address) |
TracedCallback signature for MAC send/receive events.
[in] | packet | The Packet. |
[in] | address | The source address. |
Definition at line 162 of file uan-net-device.h.
typedef std::list<Ptr<UanPhy> > ns3::UanNetDevice::UanPhyList |
List of UanPhy objects.
Definition at line 42 of file uan-net-device.h.
typedef std::list<Ptr<UanTransducer> > ns3::UanNetDevice::UanTransducerList |
List of UanTransducer objects.
Definition at line 44 of file uan-net-device.h.
ns3::UanNetDevice::UanNetDevice | ( | ) |
Default constructor.
Definition at line 30 of file uan-net-device.cc.
|
override |
Dummy destructor, DoDispose.
Definition at line 37 of file uan-net-device.cc.
|
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 378 of file uan-net-device.cc.
References ns3::TracedCallback< Ts >::ConnectWithoutContext(), and m_linkChanges.
void ns3::UanNetDevice::Clear | ( | ) |
Clear all pointer references.
Definition at line 42 of file uan-net-device.cc.
References ns3::UanTransducer::Clear(), m_channel, m_cleared, m_mac, m_node, m_phy, and m_trans.
Referenced by ns3::UanPhyGen::Clear(), and DoDispose().
|
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 84 of file uan-net-device.cc.
References Clear(), and ns3::Object::DoDispose().
|
private |
Definition at line 192 of file uan-net-device.cc.
References m_channel.
Referenced by GetTypeId().
|
overrideprotectedvirtual |
Initialize() implementation.
This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.
Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 73 of file uan-net-device.cc.
References ns3::Object::DoInitialize(), ns3::Object::Initialize(), m_channel, m_mac, m_phy, and m_trans.
|
privatevirtual |
Forward the packet to a higher level, set with SetReceiveCallback.
pkt | The packet. |
src | The source address. |
protocolNumber | The layer 3 protocol number. |
Definition at line 342 of file uan-net-device.cc.
References m_forwardUp, m_rxLogger, and NS_LOG_DEBUG.
Referenced by SetMac().
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 228 of file uan-net-device.cc.
References m_mac.
|
overridevirtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 261 of file uan-net-device.cc.
References m_mac.
Implements ns3::NetDevice.
Definition at line 222 of file uan-net-device.cc.
References m_channel.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 216 of file uan-net-device.cc.
References m_ifIndex.
Get the MAC used by this device.
Definition at line 198 of file uan-net-device.cc.
References m_mac.
Referenced by GetTypeId().
|
overridevirtual |
This value is typically used by the IP layer to perform IP fragmentation when needed.
Implements ns3::NetDevice.
Definition at line 243 of file uan-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 273 of file uan-net-device.cc.
References m_mac.
|
overridevirtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 279 of file uan-net-device.cc.
References m_mac.
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 318 of file uan-net-device.cc.
References m_node.
Referenced by ns3::UanPhyGen::EnergyDepletionHandler(), and ns3::UanPhyGen::EnergyRechargeHandler().
Get the Phy used by this device.
Definition at line 204 of file uan-net-device.cc.
References m_phy.
Referenced by GetTypeId().
Ptr< UanTransducer > ns3::UanNetDevice::GetTransducer | ( | ) | const |
Get the transducer associated with this device.
Definition at line 350 of file uan-net-device.cc.
References m_trans.
Referenced by GetTypeId().
uint32_t ns3::UanNetDevice::GetTxModeIndex | ( | ) |
Get the Tx mode index (Modulation type).
Definition at line 416 of file uan-net-device.cc.
References m_mac.
|
static |
Register this type.
Definition at line 91 of file uan-net-device.cc.
References DoGetChannel(), GetMac(), GetPhy(), GetTransducer(), m_rxLogger, m_txLogger, ns3::MakePointerAccessor(), ns3::MakePointerChecker(), ns3::MakeTraceSourceAccessor(), SetChannel(), SetMac(), ns3::TypeId::SetParent(), SetPhy(), and SetTransducer().
|
overridevirtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 285 of file uan-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 255 of file uan-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 249 of file uan-net-device.cc.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 267 of file uan-net-device.cc.
|
overridevirtual |
Return true if the net device is on a point-to-point link.
Implements ns3::NetDevice.
Definition at line 291 of file uan-net-device.cc.
|
overridevirtual |
Called by higher-layers to check if this NetDevice requires ARP to be used.
Implements ns3::NetDevice.
Definition at line 330 of file uan-net-device.cc.
|
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 297 of file uan-net-device.cc.
References ns3::Address::CopyTo(), and m_mac.
|
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 307 of file uan-net-device.cc.
References NS_ASSERT_MSG.
|
overridevirtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 397 of file uan-net-device.cc.
References ns3::Mac8Address::ConvertFrom(), m_mac, and NS_ASSERT_MSG.
void ns3::UanNetDevice::SetChannel | ( | Ptr< UanChannel > | channel | ) |
Attach a channel.
channel | The channel. |
Definition at line 171 of file uan-net-device.cc.
References m_channel, m_phy, m_trans, NS_LOG_DEBUG, and ns3::UanTransducer::SetChannel().
Referenced by GetTypeId(), and ns3::UanPhyDual::SetChannel().
|
overridevirtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 210 of file uan-net-device.cc.
References m_ifIndex.
Set the MAC layer for this device.
mac | The MAC layer. |
Definition at line 131 of file uan-net-device.cc.
References ForwardUp(), m_mac, m_phy, ns3::MakeCallback(), and NS_LOG_DEBUG.
Referenced by GetTypeId().
|
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 234 of file uan-net-device.cc.
References m_mtu, and NS_LOG_WARN.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 324 of file uan-net-device.cc.
References m_node.
Set the Phy layer for this device.
phy | The PHY layer. |
Definition at line 149 of file uan-net-device.cc.
References m_mac, m_phy, m_trans, and NS_LOG_DEBUG.
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 384 of file uan-net-device.cc.
References NS_ASSERT_MSG.
|
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 336 of file uan-net-device.cc.
References m_forwardUp.
void ns3::UanNetDevice::SetSleepMode | ( | bool | sleep | ) |
Set the Phy SLEEP mode.
sleep | SLEEP on or off. |
Definition at line 404 of file uan-net-device.cc.
References m_phy.
void ns3::UanNetDevice::SetTransducer | ( | Ptr< UanTransducer > | trans | ) |
Set the transdcuer used by this device.
trans | The transducer. |
Definition at line 356 of file uan-net-device.cc.
References m_channel, m_phy, m_trans, NS_LOG_DEBUG, and ns3::UanTransducer::SetChannel().
Referenced by GetTypeId().
void ns3::UanNetDevice::SetTxModeIndex | ( | uint32_t | txModeIndex | ) |
Set the Tx mode index (Modulation type).
txModeIndex | the Tx mode index |
Definition at line 410 of file uan-net-device.cc.
References m_mac.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 391 of file uan-net-device.cc.
|
private |
The channel attached to this device.
Definition at line 179 of file uan-net-device.h.
Referenced by Clear(), DoGetChannel(), DoInitialize(), GetChannel(), SetChannel(), and SetTransducer().
|
private |
Flag when we've been cleared.
Definition at line 196 of file uan-net-device.h.
Referenced by Clear().
|
private |
The receive callback.
Definition at line 188 of file uan-net-device.h.
Referenced by ForwardUp(), and SetReceiveCallback().
|
private |
The interface index of this device.
Definition at line 184 of file uan-net-device.h.
Referenced by GetIfIndex(), and SetIfIndex().
|
private |
Callback to invoke when the link state changes to UP.
Definition at line 187 of file uan-net-device.h.
Referenced by AddLinkChangeCallback().
|
private |
The link state, true if up.
Definition at line 186 of file uan-net-device.h.
Referenced by IsLinkUp().
The MAC layer attached to this device.
Definition at line 180 of file uan-net-device.h.
Referenced by Clear(), DoInitialize(), GetAddress(), GetBroadcast(), GetMac(), GetMulticast(), GetMulticast(), GetTxModeIndex(), Send(), SetAddress(), SetMac(), SetPhy(), and SetTxModeIndex().
|
private |
The device MTU value, in bytes.
Definition at line 185 of file uan-net-device.h.
The node hosting this device.
Definition at line 178 of file uan-net-device.h.
The PHY layer attached to this device.
Definition at line 181 of file uan-net-device.h.
Referenced by Clear(), DoInitialize(), GetPhy(), IsLinkUp(), SetChannel(), SetMac(), SetPhy(), SetSleepMode(), and SetTransducer().
|
private |
Trace source triggered when forwarding up received payload from the MAC layer.
Definition at line 191 of file uan-net-device.h.
Referenced by ForwardUp(), and GetTypeId().
|
private |
The Transducer attached to this device.
Definition at line 177 of file uan-net-device.h.
Referenced by Clear(), DoInitialize(), GetTransducer(), SetChannel(), SetPhy(), and SetTransducer().
|
private |
Trace source triggered when sending to the MAC layer.
Definition at line 193 of file uan-net-device.h.
Referenced by GetTypeId().