Base class for sink applications. More...

#include "sink-application.h"

Inheritance diagram for ns3::SinkApplication:

Collaboration diagram for ns3::SinkApplication:

Public Member Functions
	SinkApplication (uint16_t defaultPort=0)
	Constructor.
	~SinkApplication () override
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 final
	Get the most derived TypeId for this Object.
template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.
template<typename T>
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.
template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) 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.
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.
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.

Static Public Attributes
static constexpr uint32_t	INVALID_PORT {std::numeric_limits<uint32_t>::max()}
	invalid port

Protected Member Functions
bool	CloseAllSockets ()
	Close all the sockets.
void	DoDispose () override
	Destructor implementation.
Protected Member Functions inherited from ns3::Application
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.

Protected Attributes
Address	m_local
	Local address to bind to (address and port).
uint32_t	m_port
	Local port to bind to.
TypeId	m_protocolTid
	Protocol TypeId value.
TracedCallback< Ptr< const Packet >, const Address & >	m_rxTrace
	Traced Callback: received packets, source address.
ns3::TracedCallback< Ptr< const Packet > >	m_rxTraceWithoutAddress
	Callbacks for tracing the packet Rx events.
Ptr< Socket >	m_socket
	Socket (IPv4 or IPv6, depending on local address).
Ptr< Socket >	m_socket6
	IPv6 Socket (used if only port is specified).
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.

Private Member Functions
bool	CloseSocket (Ptr< Socket > socket)
	Close the socket.
virtual void	DoStartApplication ()
	Application specific startup code for child subclasses.
virtual void	DoStopApplication ()
	Application specific shutdown code for child subclasses.
Address	GetLocal () const
	get the local address
uint32_t	GetPort () const
	get the server port
virtual void	SetLocal (const Address &addr)
	set the local address
virtual void	SetPort (uint32_t port)
	set the server port
void	StartApplication () override
	Application specific startup code.
void	StopApplication () override
	Application specific shutdown code.

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

This class can be used as a base class for sink applications. A sink application is an application that is primarily used to only receive or echo packets.

The main purpose of this base class application public API is to hold attributes for the local (IPv4 or IPv6) address and port to bind to.

There are three ways that the port value can be configured. First, and most typically, through the use of a socket address (InetSocketAddress or Inet6SocketAddress) that is configured as the Local address to bind to. Second, through direct configuration of the Port attribute. Third, through the use of an optional constructor argument. If multiple of these port configuration methods are used, it is up to subclass definition which one takes precedence; in the existing subclasses in this directory, the port value configured in the Local socket address (if a socket address is configured there) will take precedence.

Config Paths

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

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

Attributes

Local: The Address on which to Bind the rx socket. If it is not specified, it will listen to any address.
- Set with class: ns3::AddressValue
- Underlying type: Address
- Initial value:
- Flags: constructwriteread
- Support level: SUPPORTED
Port: Port on which the application listens for incoming packets.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 4294967295
- 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

TraceSources

Rx: A packet has been received
- Callback signature: ns3::Packet::AddressTracedCallback
- Support level: SUPPORTED
RxWithoutAddress: A packet has been received from a given address
- Callback signature: ns3::Packet::TracedCallback
- Support level: SUPPORTED

Group: Applications
Size of this type is 224 bytes (on a 64-bit architecture).

Definition at line 43 of file sink-application.h.

Constructor & Destructor Documentation

◆ SinkApplication()

ns3::SinkApplication::SinkApplication ( uint16_t defaultPort = 0 )

Constructor.

Parameters

defaultPort the default port number

Definition at line 53 of file sink-application.cc.

References m_port, and NS_LOG_FUNCTION.

Referenced by ns3::ThreeGppHttpServer::ThreeGppHttpServer(), ns3::UdpEchoServer::UdpEchoServer(), ns3::UdpServer::UdpServer(), ns3::PacketSink::GetTypeId(), ns3::ThreeGppHttpServer::GetTypeId(), ns3::UdpEchoServer::GetTypeId(), and ns3::UdpServer::GetTypeId().

Here is the caller graph for this function:

◆ ~SinkApplication()

ns3::SinkApplication::~SinkApplication ( )

override

Definition at line 59 of file sink-application.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CloseAllSockets()

bool ns3::SinkApplication::CloseAllSockets ( )

protected

Close all the sockets.

Returns: true if all sockets closed successfully, false otherwise

Definition at line 130 of file sink-application.cc.

References CloseSocket(), m_socket, m_socket6, and NS_LOG_FUNCTION.

Referenced by ns3::ThreeGppHttpServer::DoDispose(), and StopApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CloseSocket()

bool ns3::SinkApplication::CloseSocket ( Ptr< Socket > socket )

private

Close the socket.

Parameters

socket the socket to close

Returns: true if the socket closed successfully, false otherwise

Definition at line 139 of file sink-application.cc.

References ns3::MakeNullCallback(), and NS_LOG_FUNCTION.

Referenced by CloseAllSockets().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::SinkApplication::DoDispose ( )

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

Reimplemented in ns3::ThreeGppHttpServer.

Definition at line 65 of file sink-application.cc.

References ns3::Application::DoDispose(), m_socket, m_socket6, and NS_LOG_FUNCTION.

Referenced by ns3::PacketSink::DoDispose(), and ns3::ThreeGppHttpServer::DoDispose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoStartApplication()

void ns3::SinkApplication::DoStartApplication ( )

privatevirtual

Application specific startup code for child subclasses.

Reimplemented in ns3::PacketSink, ns3::ThreeGppHttpServer, ns3::UdpEchoServer, and ns3::UdpServer.

Definition at line 157 of file sink-application.cc.

References NS_LOG_FUNCTION.

Referenced by StartApplication().

Here is the caller graph for this function:

◆ DoStopApplication()

void ns3::SinkApplication::DoStopApplication ( )

privatevirtual

Application specific shutdown code for child subclasses.

Reimplemented in ns3::PacketSink, and ns3::ThreeGppHttpServer.

Definition at line 163 of file sink-application.cc.

References NS_LOG_FUNCTION.

Referenced by StopApplication().

Here is the caller graph for this function:

◆ GetLocal()

Address ns3::SinkApplication::GetLocal ( ) const

private

get the local address

Returns: the local address

Definition at line 81 of file sink-application.cc.

References m_local.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetPort()

uint32_t ns3::SinkApplication::GetPort ( ) const

private

get the server port

Returns: the server port

Definition at line 98 of file sink-application.cc.

References m_port.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SinkApplication::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 23 of file sink-application.cc.

References ns3::Application::Application(), GetLocal(), GetPort(), INVALID_PORT, m_rxTrace, m_rxTraceWithoutAddress, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), SetLocal(), ns3::TypeId::SetParent(), and SetPort().

Here is the call graph for this function:

◆ SetLocal()

void ns3::SinkApplication::SetLocal ( const Address & addr )

privatevirtual

set the local address

Parameters

addr	local address

Reimplemented in ns3::ThreeGppHttpServer.

Definition at line 74 of file sink-application.cc.

References m_local, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetPort()

void ns3::SinkApplication::SetPort ( uint32_t port )

privatevirtual

set the server port

Parameters

port	server port

Reimplemented in ns3::ThreeGppHttpServer.

Definition at line 87 of file sink-application.cc.

References INVALID_PORT, m_port, NS_LOG_FUNCTION, and port.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ StartApplication()

void ns3::SinkApplication::StartApplication ( )

overrideprivatevirtual

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

Definition at line 104 of file sink-application.cc.

References ns3::Socket::CreateSocket(), DoStartApplication(), ns3::Application::GetNode(), m_local, m_protocolTid, m_socket, m_socket6, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ StopApplication()

void ns3::SinkApplication::StopApplication ( )

overrideprivatevirtual

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

Definition at line 122 of file sink-application.cc.

References CloseAllSockets(), DoStopApplication(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ INVALID_PORT

uint32_t ns3::SinkApplication::INVALID_PORT {std::numeric_limits<uint32_t>::max()}

staticconstexpr

invalid port

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

Referenced by GetTypeId(), SetPort(), and ns3::ThreeGppHttpServer::SetPort().

◆ m_local

Address ns3::SinkApplication::m_local

protected

Local address to bind to (address and port).

Definition at line 82 of file sink-application.h.

Referenced by ns3::PacketSink::DoStartApplication(), ns3::ThreeGppHttpServer::DoStartApplication(), ns3::UdpEchoServer::DoStartApplication(), ns3::UdpServer::DoStartApplication(), GetLocal(), ns3::ThreeGppHttpServer::ReceivedDataCallback(), SetLocal(), ns3::ThreeGppHttpServer::SetLocal(), ns3::ThreeGppHttpServer::SetPort(), and StartApplication().

◆ m_port

uint32_t ns3::SinkApplication::m_port

protected

Local port to bind to.

Definition at line 83 of file sink-application.h.

Referenced by SinkApplication(), ns3::PacketSink::DoStartApplication(), ns3::ThreeGppHttpServer::DoStartApplication(), ns3::UdpEchoServer::DoStartApplication(), ns3::UdpServer::DoStartApplication(), GetPort(), ns3::PacketSink::HandleRead(), SetPort(), and ns3::ThreeGppHttpServer::SetPort().

◆ m_protocolTid

TypeId ns3::SinkApplication::m_protocolTid

protected

Protocol TypeId value.

Definition at line 80 of file sink-application.h.

Referenced by ns3::ThreeGppHttpServer::ThreeGppHttpServer(), ns3::UdpEchoServer::UdpEchoServer(), ns3::UdpServer::UdpServer(), ns3::PacketSink::GetTypeId(), and StartApplication().

◆ m_rxTrace

TracedCallback<Ptr<const Packet>, const Address&> ns3::SinkApplication::m_rxTrace

protected

Traced Callback: received packets, source address.

Definition at line 75 of file sink-application.h.

Referenced by GetTypeId(), ns3::PacketSink::HandleRead(), ns3::UdpEchoServer::HandleRead(), ns3::UdpServer::HandleRead(), and ns3::ThreeGppHttpServer::ReceivedDataCallback().

◆ m_rxTraceWithoutAddress

ns3::TracedCallback<Ptr<const Packet> > ns3::SinkApplication::m_rxTraceWithoutAddress

protected

Callbacks for tracing the packet Rx events.

Definition at line 72 of file sink-application.h.

Referenced by GetTypeId(), ns3::PacketSink::HandleRead(), ns3::UdpEchoServer::HandleRead(), ns3::UdpServer::HandleRead(), and ns3::ThreeGppHttpServer::ReceivedDataCallback().

◆ m_socket

Ptr<Socket> ns3::SinkApplication::m_socket

protected

Socket (IPv4 or IPv6, depending on local address).

Definition at line 77 of file sink-application.h.

Referenced by CloseAllSockets(), DoDispose(), ns3::PacketSink::DoStartApplication(), ns3::ThreeGppHttpServer::DoStartApplication(), ns3::UdpEchoServer::DoStartApplication(), ns3::UdpServer::DoStartApplication(), ns3::ThreeGppHttpServer::ErrorCloseCallback(), ns3::PacketSink::GetListeningSocket(), ns3::ThreeGppHttpServer::GetSocket(), ns3::ThreeGppHttpServer::NormalCloseCallback(), and StartApplication().

◆ m_socket6

Ptr<Socket> ns3::SinkApplication::m_socket6

protected

IPv6 Socket (used if only port is specified).

Definition at line 78 of file sink-application.h.

Referenced by CloseAllSockets(), DoDispose(), ns3::PacketSink::DoStartApplication(), ns3::UdpEchoServer::DoStartApplication(), ns3::UdpServer::DoStartApplication(), and StartApplication().

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

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

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Application

TraceSources

Constructor & Destructor Documentation

◆ SinkApplication()

◆ ~SinkApplication()

Member Function Documentation

◆ CloseAllSockets()

◆ CloseSocket()

◆ DoDispose()

◆ DoStartApplication()

◆ DoStopApplication()

◆ GetLocal()

◆ GetPort()

◆ GetTypeId()

◆ SetLocal()

◆ SetPort()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ INVALID_PORT

◆ m_local

◆ m_port

◆ m_protocolTid

◆ m_rxTrace

◆ m_rxTraceWithoutAddress

◆ m_socket

◆ m_socket6