A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::lorawan::LinkCheckComponent Class Reference

Network controller component for LinkCheck commands management. More...

#include "network-controller-components.h"

+ Inheritance diagram for ns3::lorawan::LinkCheckComponent:
+ Collaboration diagram for ns3::lorawan::LinkCheckComponent:

Public Member Functions

 LinkCheckComponent ()
 Default constructor.
 
 ~LinkCheckComponent () override
 Destructor.
 
void BeforeSendingReply (Ptr< EndDeviceStatus > status, Ptr< NetworkStatus > networkStatus) override
 Function called as a downlink reply is about to leave the NetworkServer application.
 
void OnFailedReply (Ptr< EndDeviceStatus > status, Ptr< NetworkStatus > networkStatus) override
 Method that is called when a packet cannot be sent in the downlink.
 
void OnReceivedPacket (Ptr< const Packet > packet, Ptr< EndDeviceStatus > status, Ptr< NetworkStatus > networkStatus) override
 This method checks whether the received packet requires an acknowledgment and sets up the appropriate reply in case it does.
 
- Public Member Functions inherited from ns3::lorawan::NetworkControllerComponent
 NetworkControllerComponent ()
 Default constructor.
 
 ~NetworkControllerComponent () override
 Destructor.
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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::lorawan::NetworkControllerComponent
static TypeId GetTypeId ()
 Register this type.
 
- 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.
 

Additional Inherited Members

- 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.
 

Detailed Description

Network controller component for LinkCheck commands management.

Definition at line 117 of file network-controller-components.h.

Constructor & Destructor Documentation

◆ LinkCheckComponent()

ns3::lorawan::LinkCheckComponent::LinkCheckComponent ( )

Default constructor.

Definition at line 127 of file network-controller-components.cc.

◆ ~LinkCheckComponent()

ns3::lorawan::LinkCheckComponent::~LinkCheckComponent ( )
override

Destructor.

Definition at line 131 of file network-controller-components.cc.

Member Function Documentation

◆ BeforeSendingReply()

void ns3::lorawan::LinkCheckComponent::BeforeSendingReply ( Ptr< EndDeviceStatus > status,
Ptr< NetworkStatus > networkStatus )
overridevirtual

Function called as a downlink reply is about to leave the NetworkServer application.

Parameters
statusA pointer to the status of the end device which we are sending the reply to.
networkStatusA pointer to the NetworkStatus object.

Implements ns3::lorawan::NetworkControllerComponent.

Definition at line 147 of file network-controller-components.cc.

References ns3::Create(), ns3::lorawan::LoraFrameHeader::GetMacCommand(), NS_LOG_FUNCTION, ns3::lorawan::LoraFrameHeader::SetAsUplink(), and ns3::lorawan::LorawanMacHeader::UNCONFIRMED_DATA_DOWN.

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::lorawan::LinkCheckComponent::GetTypeId ( )
static

Register this type.

Returns
The object TypeId.

Definition at line 118 of file network-controller-components.cc.

References ns3::TypeId::SetParent().

Referenced by OnFailedReply(), and OnReceivedPacket().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ OnFailedReply()

void ns3::lorawan::LinkCheckComponent::OnFailedReply ( Ptr< EndDeviceStatus > status,
Ptr< NetworkStatus > networkStatus )
overridevirtual

Method that is called when a packet cannot be sent in the downlink.

Parameters
statusThe EndDeviceStatus of the device to which it was impossible to send a reply.
networkStatusA pointer to the NetworkStatus object.

Implements ns3::lorawan::NetworkControllerComponent.

Definition at line 183 of file network-controller-components.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ OnReceivedPacket()

void ns3::lorawan::LinkCheckComponent::OnReceivedPacket ( Ptr< const Packet > packet,
Ptr< EndDeviceStatus > status,
Ptr< NetworkStatus > networkStatus )
overridevirtual

This method checks whether the received packet requires an acknowledgment and sets up the appropriate reply in case it does.

Parameters
packetThe newly received packet.
statusA pointer to the EndDeviceStatus object of the sender.
networkStatusA pointer to the NetworkStatus object.

Implements ns3::lorawan::NetworkControllerComponent.

Definition at line 136 of file network-controller-components.cc.

References GetTypeId(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

The documentation for this class was generated from the following files: