Base class for source applications. More...

#include "source-application.h"

Inheritance diagram for ns3::SourceApplication:

Collaboration diagram for ns3::SourceApplication:

Public Member Functions
	SourceApplication ()

	~SourceApplication () override

Address	GetRemote () const
	get the remote address

virtual void	SetRemote (const Address &addr)
	set the remote address

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, 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 ()
	Get the type ID.

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.

Protected Attributes
Address	m_local
	Local address to bind to.

Address	m_peer
	Peer address.

uint8_t	m_tos
	The packets Type of Service.

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.

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

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

Detailed Description

Base class for source applications.

This class can be used as a base class for source applications. A source application is one that primarily sources new data towards a single remote client address and port, and may also receive data (such as an HTTP server).

The main purpose of this base class application public API is to provide a uniform way to configure remote and local addresses.

Unlike the SinkApplication, the SourceApplication does not expose an individual Port attribute. Instead, the port values are embedded in the Local and Remote address attributes, which should be configured to an InetSocketAddress or Inet6SocketAddress value that contains the desired port number.

Config Paths

ns3::SourceApplication is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/ApplicationList/[i]/$ns3::SourceApplication"

Attributes

Local: The Address on which to bind the socket. If not set, it is generated automatically when needed by the application.
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
- Support level: SUPPORTED
Remote: The address of the destination, made of the remote IP address and the destination port
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
- Support level: SUPPORTED
Tos: The Type of Service used to send IPv4 packets. All 8 bits of the TOS byte are set (including ECN bits).
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwriteread
- Support level: SUPPORTED

Attributes defined in parent class ns3::Application

StartTime: Time at which the application will start
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: constructwriteread
- Support level: SUPPORTED
StopTime: Time at which the application will stop
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: constructwriteread
- Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Applications

Size of this type is 176 bytes (on a 64-bit architecture).

Definition at line 34 of file source-application.h.

Constructor & Destructor Documentation

◆ SourceApplication()

ns3::SourceApplication::SourceApplication ( )

Definition at line 50 of file source-application.cc.

References NS_LOG_FUNCTION.

◆ ~SourceApplication()

ns3::SourceApplication::~SourceApplication ( )

override

Definition at line 56 of file source-application.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ GetRemote()

Address ns3::SourceApplication::GetRemote ( ) const

get the remote address

Returns: the remote address

Definition at line 72 of file source-application.cc.

References m_peer.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SourceApplication::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 22 of file source-application.cc.

References GetRemote(), m_local, m_tos, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::TypeId::SetParent(), and SetRemote().

Here is the call graph for this function:

◆ SetRemote()

void ns3::SourceApplication::SetRemote ( const Address & addr )

virtual

set the remote address

Parameters

addr	remote address

Reimplemented in ns3::ThreeGppHttpClient, ns3::UdpClient, ns3::UdpEchoClient, and ns3::UdpTraceClient.

Definition at line 62 of file source-application.cc.

References ns3::Address::IsInvalid(), m_peer, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_local

Address ns3::SourceApplication::m_local

protected

Local address to bind to.

Definition at line 60 of file source-application.h.

Referenced by GetTypeId(), ns3::ThreeGppHttpClient::OpenConnection(), ns3::BulkSendApplication::StartApplication(), ns3::OnOffApplication::StartApplication(), ns3::UdpClient::StartApplication(), ns3::UdpEchoClient::StartApplication(), and ns3::UdpTraceClient::StartApplication().

◆ m_peer

Address ns3::SourceApplication::m_peer

protected

Peer address.

Definition at line 59 of file source-application.h.

Referenced by ns3::ThreeGppHttpClient::ConnectionFailedCallback(), ns3::UdpClient::GetPort(), ns3::UdpEchoClient::GetPort(), ns3::UdpTraceClient::GetPort(), GetRemote(), ns3::UdpClient::GetRemote(), ns3::UdpEchoClient::GetRemote(), ns3::UdpTraceClient::GetRemote(), ns3::ThreeGppHttpClient::OpenConnection(), ns3::UdpEchoClient::Send(), ns3::OnOffApplication::SendPacket(), ns3::UdpTraceClient::SendPacket(), ns3::ThreeGppHttpClient::SetPort(), ns3::UdpClient::SetPort(), ns3::UdpEchoClient::SetPort(), ns3::UdpTraceClient::SetPort(), SetRemote(), ns3::ThreeGppHttpClient::SetRemote(), ns3::UdpClient::SetRemote(), ns3::UdpEchoClient::SetRemote(), ns3::UdpTraceClient::SetRemote(), ns3::BulkSendApplication::StartApplication(), ns3::OnOffApplication::StartApplication(), ns3::UdpClient::StartApplication(), ns3::UdpEchoClient::StartApplication(), and ns3::UdpTraceClient::StartApplication().

◆ m_tos

uint8_t ns3::SourceApplication::m_tos

protected

The packets Type of Service.

Definition at line 61 of file source-application.h.

Referenced by GetTypeId(), ns3::ThreeGppHttpClient::OpenConnection(), ns3::BulkSendApplication::StartApplication(), ns3::OnOffApplication::StartApplication(), ns3::UdpClient::StartApplication(), ns3::UdpEchoClient::StartApplication(), and ns3::UdpTraceClient::StartApplication().

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

src/applications/model/source-application.h
src/applications/model/source-application.cc

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Application

Constructor & Destructor Documentation

◆ SourceApplication()

◆ ~SourceApplication()

Member Function Documentation

◆ GetRemote()

◆ GetTypeId()

◆ SetRemote()

Member Data Documentation

◆ m_local

◆ m_peer

◆ m_tos