#include "packet-socket-server.h"

Inheritance diagram for ns3::PacketSocketServer:

Collaboration diagram for ns3::PacketSocketServer:

Public Member Functions
	PacketSocketServer ()

	~PacketSocketServer () override

void	SetLocal (PacketSocketAddress addr)
	set the local address and protocol to be used

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

Private Member Functions
void	HandleRead (Ptr< Socket > socket)
	Handle a packet received by the application.

void	StartApplication () override
	Application specific startup code.

void	StopApplication () override
	Application specific shutdown code.

Private Attributes
uint32_t	m_bytesRx
	Total bytes received.

PacketSocketAddress	m_localAddress
	Local address.

bool	m_localAddressSet
	Sanity check.

uint32_t	m_pktRx
	The number of received packets.

TracedCallback< Ptr< const Packet >, const Address & >	m_rxTrace
	Traced Callback: received packets, source address.

Ptr< Socket >	m_socket
	Socket.

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 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 Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

A server using PacketSocket.

Receives packets using PacketSocket. It does not require (or use) IP. The application has the same requirements as the PacketSocket for what concerns the underlying NetDevice and the Address scheme. It is meant to be used in ns-3 tests.

Provides a "Rx" Traced Callback (received packets, source address)

Definition at line 37 of file packet-socket-server.h.

Constructor & Destructor Documentation

◆ PacketSocketServer()

ns3::PacketSocketServer::PacketSocketServer ( )

Definition at line 48 of file packet-socket-server.cc.

References m_bytesRx, m_localAddressSet, m_pktRx, m_socket, and NS_LOG_FUNCTION.

◆ ~PacketSocketServer()

ns3::PacketSocketServer::~PacketSocketServer ( )

override

Definition at line 57 of file packet-socket-server.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoDispose()

void ns3::PacketSocketServer::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.

Definition at line 63 of file packet-socket-server.cc.

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

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::PacketSocketServer::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 35 of file packet-socket-server.cc.

References m_rxTrace, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ HandleRead()

void ns3::PacketSocketServer::HandleRead ( Ptr< Socket > socket )

private

Handle a packet received by the application.

Parameters

socket the receiving socket

Definition at line 102 of file packet-socket-server.cc.

References ns3::PacketSocketAddress::ConvertFrom(), ns3::PacketSocketAddress::IsMatchingType(), m_bytesRx, m_pktRx, m_rxTrace, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::Time::S.

Referenced by StartApplication().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLocal()

void ns3::PacketSocketServer::SetLocal ( PacketSocketAddress addr )

set the local address and protocol to be used

Parameters

addr	local address

Definition at line 94 of file packet-socket-server.cc.

References m_localAddress, m_localAddressSet, and NS_LOG_FUNCTION.

◆ StartApplication()

void ns3::PacketSocketServer::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 70 of file packet-socket-server.cc.

References ns3::Socket::Bind(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), HandleRead(), ns3::TypeId::LookupByName(), m_localAddress, m_localAddressSet, m_socket, ns3::MakeCallback(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().

Here is the call graph for this function:

◆ StopApplication()

void ns3::PacketSocketServer::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 86 of file packet-socket-server.cc.

References ns3::Socket::Close(), m_socket, ns3::MakeNullCallback(), NS_LOG_FUNCTION, and ns3::Socket::SetRecvCallback().

Here is the call graph for this function:

Member Data Documentation

◆ m_bytesRx

uint32_t ns3::PacketSocketServer::m_bytesRx

private

Total bytes received.

Definition at line 70 of file packet-socket-server.h.

Referenced by PacketSocketServer(), and HandleRead().

◆ m_localAddress

PacketSocketAddress ns3::PacketSocketServer::m_localAddress

private

Local address.

Definition at line 73 of file packet-socket-server.h.

Referenced by SetLocal(), and StartApplication().

◆ m_localAddressSet

bool ns3::PacketSocketServer::m_localAddressSet

private

Sanity check.

Definition at line 74 of file packet-socket-server.h.

Referenced by PacketSocketServer(), SetLocal(), and StartApplication().

◆ m_pktRx

uint32_t ns3::PacketSocketServer::m_pktRx

private

The number of received packets.

Definition at line 69 of file packet-socket-server.h.

Referenced by PacketSocketServer(), and HandleRead().

◆ m_rxTrace

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

private

Traced Callback: received packets, source address.

Definition at line 77 of file packet-socket-server.h.

Referenced by GetTypeId(), and HandleRead().

◆ m_socket

Ptr<Socket> ns3::PacketSocketServer::m_socket

private

Socket.

Definition at line 72 of file packet-socket-server.h.

Referenced by PacketSocketServer(), StartApplication(), and StopApplication().

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

src/network/utils/packet-socket-server.h
src/network/utils/packet-socket-server.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PacketSocketServer()

◆ ~PacketSocketServer()

Member Function Documentation

◆ DoDispose()

◆ GetTypeId()

◆ HandleRead()

◆ SetLocal()

◆ StartApplication()

◆ StopApplication()

Member Data Documentation

◆ m_bytesRx

◆ m_localAddress

◆ m_localAddressSet

◆ m_pktRx

◆ m_rxTrace

◆ m_socket