Hold together all LoRa related objects. More...
#include "lora-net-device.h"
Public Member Functions | |
LoraNetDevice () | |
Default constructor. | |
~LoraNetDevice () override | |
Destructor. | |
void | AddLinkChangeCallback (Callback< void > callback) override |
Address | GetAddress () const override |
Address | GetBroadcast () const override |
Ptr< Channel > | GetChannel () const override |
uint32_t | GetIfIndex () const override |
Ptr< LorawanMac > | GetMac () const |
Get the LorawanMac instance that is linked to this NetDevice. | |
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< LoraPhy > | GetPhy () const |
Get the LoraPhy instance that is linked to this NetDevice. | |
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 |
void | Receive (Ptr< Packet > packet) |
Callback the Mac layer calls whenever a packet arrives and needs to be forwarded up the stack. | |
void | Send (Ptr< Packet > packet) |
Send a packet through the LoRaWAN stack. | |
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 | SetIfIndex (const uint32_t index) override |
void | SetMac (Ptr< LorawanMac > mac) |
Set which LorawanMac instance is linked to this device. | |
bool | SetMtu (const uint16_t mtu) override |
void | SetNode (Ptr< Node > node) override |
void | SetPhy (Ptr< LoraPhy > phy) |
Set which LoraPhy instance is linked to this device. | |
void | SetPromiscReceiveCallback (PromiscReceiveCallback cb) override |
void | SetReceiveCallback (NetDevice::ReceiveCallback cb) override |
bool | SupportsSendFrom () const override |
Public Member Functions inherited from ns3::NetDevice | |
~NetDevice () override | |
virtual void | AddLinkChangeCallback (Callback< void > callback)=0 |
virtual Address | GetAddress () const =0 |
virtual Address | GetBroadcast () const =0 |
virtual Ptr< Channel > | GetChannel () const =0 |
virtual uint32_t | GetIfIndex () const =0 |
virtual uint16_t | GetMtu () const =0 |
virtual Address | GetMulticast (Ipv4Address multicastGroup) const =0 |
Make and return a MAC multicast address using the provided multicast group. | |
virtual Address | GetMulticast (Ipv6Address addr) const =0 |
Get the MAC multicast address corresponding to the IPv6 address provided. | |
virtual Ptr< Node > | GetNode () const =0 |
virtual bool | IsBridge () const =0 |
Return true if the net device is acting as a bridge. | |
virtual bool | IsBroadcast () const =0 |
virtual bool | IsLinkUp () const =0 |
virtual bool | IsMulticast () const =0 |
virtual bool | IsPointToPoint () const =0 |
Return true if the net device is on a point-to-point link. | |
virtual bool | NeedsArp () 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 void | SetAddress (Address address)=0 |
Set the address of this interface. | |
virtual void | SetIfIndex (const uint32_t index)=0 |
virtual bool | SetMtu (const uint16_t mtu)=0 |
virtual void | SetNode (Ptr< Node > node)=0 |
virtual void | SetPromiscReceiveCallback (PromiscReceiveCallback cb)=0 |
virtual void | SetReceiveCallback (ReceiveCallback cb)=0 |
virtual bool | SupportsSendFrom () const =0 |
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) 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. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
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 | ForwardUp (Ptr< Packet > packet, Mac48Address from, Mac48Address to) |
Receive a packet from the lower layer and pass the packet up the stack. | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
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 | |
void | CompleteConfig () |
Complete the configuration of this LoRa device by connecting all lower components (PHY, MAC, Channel) together. | |
Ptr< LoraChannel > | DoGetChannel () const |
Return the LoraChannel this device is connected to. | |
Private Attributes | |
bool | m_configComplete |
Whether the configuration was already completed. | |
Ptr< LorawanMac > | m_mac |
The LorawanMac this NetDevice is connected to. | |
Ptr< Node > | m_node |
The Node this NetDevice is connected to. | |
Ptr< LoraPhy > | m_phy |
The LoraPhy this NetDevice is connected to. | |
NetDevice::ReceiveCallback | m_receiveCallback |
Upper layer callback used for notification of new data packet arrivals. | |
Additional Inherited Members | |
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 |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Hold together all LoRa related objects.
This class holds together pointers to LoraChannel, LoraPhy and LorawanMac, exposing methods through which Application instances can send packets. The Application only needs to craft its packets, the NetDevice will take care of calling the LorawanMac's Send method with the appropriate parameters.
Definition at line 55 of file lora-net-device.h.
ns3::lorawan::LoraNetDevice::LoraNetDevice | ( | ) |
Default constructor.
Definition at line 62 of file lora-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
override |
|
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 206 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
|
private |
Complete the configuration of this LoRa device by connecting all lower components (PHY, MAC, Channel) together.
Definition at line 101 of file lora-net-device.cc.
References m_configComplete, m_mac, m_node, m_phy, and NS_LOG_FUNCTION_NOARGS.
Referenced by SetNode().
|
private |
Return the LoraChannel this device is connected to.
Definition at line 147 of file lora-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
Referenced by GetTypeId().
|
protected |
Receive a packet from the lower layer and pass the packet up the stack.
packet | The packet we need to forward. |
from | The from address. |
to | The to address. |
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 174 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Calling this method is invalid if IsBroadcast returns not true.
Implements ns3::NetDevice.
Definition at line 220 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
Implements ns3::NetDevice.
Definition at line 140 of file lora-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 160 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
Ptr< LorawanMac > ns3::lorawan::LoraNetDevice::GetMac | ( | ) | const |
Get the LorawanMac instance that is linked to this NetDevice.
Definition at line 83 of file lora-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 190 of file lora-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 236 of file lora-net-device.cc.
References NS_ABORT_MSG.
|
overridevirtual |
Get the MAC multicast address corresponding to the IPv6 address provided.
addr | IPv6 address |
Implements ns3::NetDevice.
Definition at line 244 of file lora-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 292 of file lora-net-device.cc.
References m_node, and NS_LOG_FUNCTION.
Get the LoraPhy instance that is linked to this NetDevice.
Definition at line 95 of file lora-net-device.cc.
References m_phy.
Referenced by GetTypeId().
|
static |
Register this type.
Definition at line 37 of file lora-net-device.cc.
References DoGetChannel(), GetMac(), GetPhy(), ns3::MakePointerAccessor(), SetMac(), ns3::TypeId::SetParent(), and SetPhy().
|
overridevirtual |
Return true if the net device is acting as a bridge.
Implements ns3::NetDevice.
Definition at line 252 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 212 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 198 of file lora-net-device.cc.
References m_phy, and NS_LOG_FUNCTION.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 228 of file lora-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 260 of file lora-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 309 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
Callback the Mac layer calls whenever a packet arrives and needs to be forwarded up the stack.
packet | The packet that was received. |
Definition at line 126 of file lora-net-device.cc.
References m_receiveCallback, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
Send a packet through the LoRaWAN stack.
packet | The packet to send. |
Definition at line 116 of file lora-net-device.cc.
References m_mac, NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by Send().
|
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 268 of file lora-net-device.cc.
References NS_LOG_FUNCTION, and Send().
|
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 280 of file lora-net-device.cc.
References NS_ABORT_MSG.
|
overridevirtual |
Set the address of this interface.
address | address to set |
Implements ns3::NetDevice.
Definition at line 168 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
|
overridevirtual |
index | ifIndex of the device |
Implements ns3::NetDevice.
Definition at line 154 of file lora-net-device.cc.
References NS_LOG_FUNCTION.
void ns3::lorawan::LoraNetDevice::SetMac | ( | Ptr< LorawanMac > | mac | ) |
Set which LorawanMac instance is linked to this device.
mac | The MAC layer to use. |
Definition at line 77 of file lora-net-device.cc.
References m_mac.
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 182 of file lora-net-device.cc.
References NS_ABORT_MSG.
node | the node associated to this netdevice. |
This method is called from ns3::Node::AddDevice.
Implements ns3::NetDevice.
Definition at line 300 of file lora-net-device.cc.
References CompleteConfig(), m_node, and NS_LOG_FUNCTION.
Set which LoraPhy instance is linked to this device.
phy | The PHY layer to use. |
Definition at line 89 of file lora-net-device.cc.
References m_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 324 of file lora-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
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 317 of file lora-net-device.cc.
References m_receiveCallback, and NS_LOG_FUNCTION_NOARGS.
|
overridevirtual |
Implements ns3::NetDevice.
Definition at line 330 of file lora-net-device.cc.
References NS_LOG_FUNCTION_NOARGS.
|
private |
Whether the configuration was already completed.
Definition at line 179 of file lora-net-device.h.
Referenced by CompleteConfig().
|
private |
The LorawanMac this NetDevice is connected to.
Definition at line 178 of file lora-net-device.h.
Referenced by CompleteConfig(), GetMac(), Send(), and SetMac().
The Node this NetDevice is connected to.
Definition at line 176 of file lora-net-device.h.
Referenced by CompleteConfig(), GetNode(), and SetNode().
The LoraPhy this NetDevice is connected to.
Definition at line 177 of file lora-net-device.h.
Referenced by CompleteConfig(), DoGetChannel(), GetChannel(), GetPhy(), IsLinkUp(), and SetPhy().
|
private |
Upper layer callback used for notification of new data packet arrivals.
Definition at line 184 of file lora-net-device.h.
Referenced by Receive(), and SetReceiveCallback().