This application forwards packets between NetDevices: LoraNetDevice -> PointToPointNetDevice and vice versa. More...

#include "forwarder.h"

Inheritance diagram for ns3::lorawan::Forwarder:

Collaboration diagram for ns3::lorawan::Forwarder:

Public Member Functions
	Forwarder ()
	Default constructor.

	~Forwarder () override
	Destructor.

bool	ReceiveFromLora (Ptr< NetDevice > loraNetDevice, Ptr< const Packet > packet, uint16_t protocol, const Address &sender)
	Receive a packet from the LoraNetDevice.

bool	ReceiveFromPointToPoint (Ptr< NetDevice > device, Ptr< const Packet > packet, uint16_t protocol, const Address &sender)
	Receive a packet from the PointToPointNetDevice.

void	SetLoraNetDevice (Ptr< LoraNetDevice > loraNetDevice)
	Sets the device to use to communicate with the end devices.

void	SetPointToPointNetDevice (Ptr< PointToPointNetDevice > pointToPointNetDevice)
	Sets the P2P device to use to communicate with the network server.

void	StartApplication () override
	Start the application.

void	StopApplication () override
	Stop the application.

Public Member Functions inherited from ns3::Application
	Application ()

	~Application () override

virtual int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this Application object.

Ptr< Node >	GetNode () const

void	SetNode (Ptr< Node > node)

void	SetStartTime (Time start)
	Specify application start time.

void	SetStopTime (Time stop)
	Specify application stop time.

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

Private Attributes
Ptr< LoraNetDevice >	m_loraNetDevice
	Pointer to the node's LoraNetDevice.

Ptr< PointToPointNetDevice >	m_pointToPointNetDevice
	Pointer to the P2PNetDevice we use to communicate with the network server.

Additional Inherited Members
Public Types inherited from ns3::Application
typedef void(*	DelayAddressCallback) (const Time &delay, const Address &from)
	Common callback signature for packet delay and address.

typedef void(*	StateTransitionCallback) (const std::string &oldState, const std::string &newState)
	Common signature used by callbacks to application's state transition trace source.

Protected Member Functions inherited from ns3::Application
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	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.

Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node
	The node that this application is installed on.

EventId	m_startEvent
	The event that will fire at m_startTime to start the application.

Time	m_startTime
	The simulation time that the application will start.

EventId	m_stopEvent
	The event that will fire at m_stopTime to end the application.

Time	m_stopTime
	The simulation time that the application will end.

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

This application forwards packets between NetDevices: LoraNetDevice -> PointToPointNetDevice and vice versa.

Definition at line 41 of file forwarder.h.

Constructor & Destructor Documentation

◆ Forwarder()

ns3::lorawan::Forwarder::Forwarder ( )

Default constructor.

Definition at line 43 of file forwarder.cc.

References NS_LOG_FUNCTION_NOARGS.

◆ ~Forwarder()

ns3::lorawan::Forwarder::~Forwarder ( )

override

Destructor.

Definition at line 48 of file forwarder.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ GetTypeId()

TypeId ns3::lorawan::Forwarder::GetTypeId ( )

static

Register this type.

Returns: The object TypeId.

Definition at line 34 of file forwarder.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ ReceiveFromLora()

bool ns3::lorawan::Forwarder::ReceiveFromLora	(	Ptr< NetDevice >	loraNetDevice,
		Ptr< const Packet >	packet,
		uint16_t	protocol,
		const Address &	sender
	)

Receive a packet from the LoraNetDevice.

Parameters

loraNetDevice	The LoraNetDevice we received the packet from.
packet	The packet we received.
protocol	The protocol number associated to this packet.
sender	The address of the sender.

Returns: True if we can handle the packet, false otherwise.

Definition at line 70 of file forwarder.cc.

References m_pointToPointNetDevice, and NS_LOG_FUNCTION.

Referenced by ns3::lorawan::ForwarderHelper::InstallPriv().

Here is the caller graph for this function:

◆ ReceiveFromPointToPoint()

bool ns3::lorawan::Forwarder::ReceiveFromPointToPoint	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	packet,
		uint16_t	protocol,
		const Address &	sender
	)

Receive a packet from the PointToPointNetDevice.

Parameters

device	a pointer to the net device which is calling this callback
packet	the packet received
protocol	the 16 bit protocol number associated with this packet. This protocol number is expected to be the same protocol number given to the Send method by the user on the sender side.
sender	the address of the sender

Returns: true if the callback could handle the packet successfully, false otherwise.

Definition at line 85 of file forwarder.cc.

References m_loraNetDevice, and NS_LOG_FUNCTION.

Referenced by ns3::lorawan::ForwarderHelper::InstallPriv().

Here is the caller graph for this function:

◆ SetLoraNetDevice()

void ns3::lorawan::Forwarder::SetLoraNetDevice ( Ptr< LoraNetDevice > loraNetDevice )

Sets the device to use to communicate with the end devices.

Parameters

loraNetDevice The LoraNetDevice on this node.

Definition at line 62 of file forwarder.cc.

References m_loraNetDevice, and NS_LOG_FUNCTION.

◆ SetPointToPointNetDevice()

void ns3::lorawan::Forwarder::SetPointToPointNetDevice ( Ptr< PointToPointNetDevice > pointToPointNetDevice )

Sets the P2P device to use to communicate with the network server.

Parameters

pointToPointNetDevice The P2PNetDevice on this node.

Definition at line 54 of file forwarder.cc.

References m_pointToPointNetDevice, and NS_LOG_FUNCTION.

◆ StartApplication()

void ns3::lorawan::Forwarder::StartApplication ( )

overridevirtual

Start the application.

Reimplemented from ns3::Application.

Definition at line 100 of file forwarder.cc.

References NS_LOG_FUNCTION.

◆ StopApplication()

void ns3::lorawan::Forwarder::StopApplication ( )

overridevirtual

Stop the application.

Reimplemented from ns3::Application.

Definition at line 108 of file forwarder.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Data Documentation

◆ m_loraNetDevice

Ptr<LoraNetDevice> ns3::lorawan::Forwarder::m_loraNetDevice

private

Pointer to the node's LoraNetDevice.

Definition at line 102 of file forwarder.h.

Referenced by ReceiveFromPointToPoint(), and SetLoraNetDevice().

◆ m_pointToPointNetDevice

Ptr<PointToPointNetDevice> ns3::lorawan::Forwarder::m_pointToPointNetDevice

private

Pointer to the P2PNetDevice we use to communicate with the network server.

Definition at line 104 of file forwarder.h.

Referenced by ReceiveFromLora(), and SetPointToPointNetDevice().

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

src/lorawan/model/forwarder.h
src/lorawan/model/forwarder.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Forwarder()

◆ ~Forwarder()

Member Function Documentation

◆ GetTypeId()

◆ ReceiveFromLora()

◆ ReceiveFromPointToPoint()

◆ SetLoraNetDevice()

◆ SetPointToPointNetDevice()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_loraNetDevice

◆ m_pointToPointNetDevice