The base class for all ns3 applications. More...

#include "application.h"

Inheritance diagram for ns3::Application:

Collaboration diagram for ns3::Application:

Public Types
typedef void(*	DelayAddressCallback) (const Time &delay, const Address &from)
	Common callback signature for packet delay and address. More...

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

Public Member Functions
	Application ()

	~Application () override

Ptr< Node >	GetNode () const

void	SetNode (Ptr< Node > node)

void	SetStartTime (Time start)
	Specify application start time. More...

void	SetStopTime (Time stop)
	Specify application stop time. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Protected Member Functions
void	DoDispose () override
	Destructor implementation. More...

void	DoInitialize () override
	Initialize() implementation. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Protected Attributes
Ptr< Node >	m_node
	The node that this application is installed on. More...

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

Time	m_startTime
	The simulation time that the application will start. More...

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

Time	m_stopTime
	The simulation time that the application will end. More...

Private Member Functions
virtual void	StartApplication ()
	Application specific startup code. More...

virtual void	StopApplication ()
	Application specific shutdown code. More...

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

Detailed Description

The base class for all ns3 applications.

Definition at line 61 of file application.h.

Member Typedef Documentation

◆ DelayAddressCallback

typedef void(* ns3::Application::DelayAddressCallback) (const Time &delay, const Address &from)

Common callback signature for packet delay and address.

Parameters

delay	The packet delay.
from	The source socket address associated with the packet, indicating the packet's origin.

Definition at line 115 of file application.h.

◆ StateTransitionCallback

typedef void(* ns3::Application::StateTransitionCallback) (const std::string &oldState, const std::string &newState)

Common signature used by callbacks to application's state transition trace source.

Parameters

oldState	The name of the previous state.
newState	The name of the current state.

Definition at line 123 of file application.h.

Constructor & Destructor Documentation

◆ Application()

ns3::Application::Application ( )

Definition at line 60 of file application.cc.

References NS_LOG_FUNCTION.

◆ ~Application()

ns3::Application::~Application ( )

override

Definition at line 66 of file application.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::Application::DoDispose ( void )

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.

Reimplemented in ns3::PacketSocketServer, and ns3::PacketSocketClient.

Definition at line 86 of file application.cc.

References ns3::EventId::Cancel(), ns3::Object::DoDispose(), m_node, m_startEvent, m_stopEvent, and NS_LOG_FUNCTION.

Referenced by Sender::DoDispose(), Receiver::DoDispose(), ns3::BulkSendApplication::DoDispose(), ns3::OnOffApplication::DoDispose(), ns3::PacketSink::DoDispose(), ns3::ThreeGppHttpClient::DoDispose(), ns3::ThreeGppHttpServer::DoDispose(), ns3::UdpClient::DoDispose(), ns3::UdpEchoClient::DoDispose(), ns3::UdpEchoServer::DoDispose(), ns3::UdpServer::DoDispose(), ns3::UdpTraceClient::DoDispose(), ns3::DhcpClient::DoDispose(), ns3::DhcpServer::DoDispose(), ns3::Ping::DoDispose(), ns3::Radvd::DoDispose(), ns3::V4TraceRoute::DoDispose(), ns3::PacketSocketClient::DoDispose(), ns3::PacketSocketServer::DoDispose(), ns3::QKDKeyManagerSystemApplication::DoDispose(), ns3::QKDPostprocessingApplication::DoDispose(), and ns3::QKDSDNController::DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoInitialize()

void ns3::Application::DoInitialize ( void )

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 96 of file application.cc.

References ns3::Object::DoInitialize(), m_startEvent, m_startTime, m_stopEvent, m_stopTime, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), StartApplication(), and StopApplication().

Here is the call graph for this function:

◆ GetNode()

Ptr< Node > ns3::Application::GetNode ( ) const

Returns: the Node to which this Application object is attached.

Definition at line 108 of file application.cc.

References m_node, and NS_LOG_FUNCTION.

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Application::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

Definition at line 41 of file application.cc.

References m_startTime, m_stopTime, ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ SetNode()

void ns3::Application::SetNode ( Ptr< Node > node )

Parameters

node	the node to which this Application object is attached.

Definition at line 115 of file application.cc.

References m_node, and NS_LOG_FUNCTION.

Referenced by ns3::Node::AddApplication().

Here is the caller graph for this function:

◆ SetStartTime()

void ns3::Application::SetStartTime ( Time start )

Specify application start time.

Parameters

start Start time for this application, relative to the current simulation time.

Applications start at various times in the simulation scenario. This method specifies when the application should be started. The application subclasses should override the private "StartApplication" method defined below, which is called at the time specified, to cause the application to begin.

Definition at line 72 of file application.cc.

References m_startTime, NS_LOG_FUNCTION, and two-ray-to-three-gpp-ch-calibration::start.

◆ SetStopTime()

void ns3::Application::SetStopTime ( Time stop )

Specify application stop time.

Parameters

stop	Stop time for this application, relative to the current simulation time.

Once an application has started, it is sometimes useful to stop the application. This method specifies when an application is to stop. The application subclasses should override the private StopApplication method, to be notified when that time has come.

Definition at line 79 of file application.cc.

References m_stopTime, NS_LOG_FUNCTION, and two-ray-to-three-gpp-ch-calibration::stop.

◆ StartApplication()

void ns3::Application::StartApplication ( void )

privatevirtual

Application specific startup code.

The StartApplication method is called at the start time specified by Start This method should be overridden by all or most application subclasses.

Reimplemented in ns3::QKDSDNController, ns3::QKDPostprocessingApplication, ns3::QKDKeyManagerSystemApplication, ns3::QKDApp014, ns3::QKDApp004, ns3::SocketWriter, ns3::PacketSocketServer, ns3::PacketSocketClient, EpsBearerTagUdpClient, ns3::V4TraceRoute, ns3::Radvd, ns3::Ping, ns3::DhcpServer, ns3::DhcpClient, ns3::UdpTraceClient, ns3::UdpServer, ns3::UdpEchoServer, ns3::UdpEchoClient, ns3::UdpClient, ns3::ThreeGppHttpServer, ns3::ThreeGppHttpClient, ns3::PacketSink, ns3::OnOffApplication, ns3::BulkSendApplication, ns3::TutorialApp, Receiver, and Sender.

Definition at line 124 of file application.cc.

References NS_LOG_FUNCTION.

Referenced by DoInitialize().

Here is the caller graph for this function:

◆ StopApplication()

void ns3::Application::StopApplication ( void )

privatevirtual

Application specific shutdown code.

The StopApplication method is called at the stop time specified by Stop This method should be overridden by all or most application subclasses.

Reimplemented in ns3::QKDSDNController, ns3::QKDPostprocessingApplication, ns3::QKDKeyManagerSystemApplication, ns3::QKDApp014, ns3::QKDApp004, ns3::SocketWriter, ns3::PacketSocketServer, ns3::PacketSocketClient, EpsBearerTagUdpClient, ns3::V4TraceRoute, ns3::Radvd, ns3::Ping, ns3::DhcpServer, ns3::DhcpClient, ns3::UdpTraceClient, ns3::UdpServer, ns3::UdpEchoServer, ns3::UdpEchoClient, ns3::UdpClient, ns3::ThreeGppHttpServer, ns3::ThreeGppHttpClient, ns3::PacketSink, ns3::OnOffApplication, ns3::BulkSendApplication, ns3::TutorialApp, Receiver, and Sender.

Definition at line 130 of file application.cc.

References NS_LOG_FUNCTION.

Referenced by DoInitialize().

Here is the caller graph for this function:

Member Data Documentation

◆ m_node

Ptr<Node> ns3::Application::m_node

protected

The node that this application is installed on.

Definition at line 149 of file application.h.

Referenced by DoDispose(), GetNode(), ns3::Ping::Receive(), and SetNode().

◆ m_startEvent

EventId ns3::Application::m_startEvent

protected

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

Definition at line 152 of file application.h.

Referenced by DoDispose(), and DoInitialize().

◆ m_startTime

Time ns3::Application::m_startTime

protected

The simulation time that the application will start.

Definition at line 150 of file application.h.

Referenced by DoInitialize(), GetTypeId(), and SetStartTime().

◆ m_stopEvent

EventId ns3::Application::m_stopEvent

protected

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

Definition at line 153 of file application.h.

Referenced by DoDispose(), DoInitialize(), and ns3::Ping::StopApplication().

◆ m_stopTime

Time ns3::Application::m_stopTime

protected

The simulation time that the application will end.

Definition at line 151 of file application.h.

Referenced by DoInitialize(), GetTypeId(), SetStopTime(), and ns3::Ping::StartApplication().

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

src/network/model/application.h
src/network/model/application.cc

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DelayAddressCallback

◆ StateTransitionCallback

Constructor & Destructor Documentation

◆ Application()

◆ ~Application()

Member Function Documentation

◆ DoDispose()

◆ DoInitialize()

◆ GetNode()

◆ GetTypeId()

◆ SetNode()

◆ SetStartTime()

◆ SetStopTime()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_node

◆ m_startEvent

◆ m_startTime

◆ m_stopEvent

◆ m_stopTime