Object to create UDP socket instances. More...

#include "udp-socket-factory-impl.h"

Inheritance diagram for ns3::UdpSocketFactoryImpl:

Collaboration diagram for ns3::UdpSocketFactoryImpl:

Public Member Functions
	UdpSocketFactoryImpl ()

	~UdpSocketFactoryImpl () override

Ptr< Socket >	CreateSocket () override
	Implements a method to create a Udp-based socket and return a base class smart pointer to the socket.

void	SetUdp (Ptr< UdpL4Protocol > udp)
	Set the associated UDP L4 protocol.

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

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.

Protected Member Functions
void	DoDispose () override
	Destructor implementation.

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

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.

Private Attributes
Ptr< UdpL4Protocol >	m_udp
	the associated UDP L4 protocol

Additional Inherited Members
Static Public Member Functions inherited from ns3::UdpSocketFactory
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::SocketFactory
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.

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

Object to create UDP socket instances.

This class implements the API for creating UDP sockets. It is a socket factory (deriving from class SocketFactory).

Definition at line 29 of file udp-socket-factory-impl.h.

Constructor & Destructor Documentation

◆ UdpSocketFactoryImpl()

ns3::UdpSocketFactoryImpl::UdpSocketFactoryImpl ( )

Definition at line 18 of file udp-socket-factory-impl.cc.

◆ ~UdpSocketFactoryImpl()

ns3::UdpSocketFactoryImpl::~UdpSocketFactoryImpl ( )

override

Definition at line 23 of file udp-socket-factory-impl.cc.

References m_udp, and NS_ASSERT.

Member Function Documentation

◆ CreateSocket()

Ptr< Socket > ns3::UdpSocketFactoryImpl::CreateSocket ( )

overridevirtual

Implements a method to create a Udp-based socket and return a base class smart pointer to the socket.

Returns: smart pointer to Socket

Implements ns3::SocketFactory.

Definition at line 35 of file udp-socket-factory-impl.cc.

References ns3::Socket::CreateSocket(), and m_udp.

Here is the call graph for this function:

◆ DoDispose()

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

Definition at line 41 of file udp-socket-factory-impl.cc.

References ns3::Object::DoDispose(), and m_udp.

Here is the call graph for this function:

◆ SetUdp()

void ns3::UdpSocketFactoryImpl::SetUdp ( Ptr< UdpL4Protocol > udp )

Set the associated UDP L4 protocol.

Parameters

udp	the UDP L4 protocol

Definition at line 29 of file udp-socket-factory-impl.cc.

References m_udp.

Member Data Documentation

◆ m_udp

Ptr<UdpL4Protocol> ns3::UdpSocketFactoryImpl::m_udp

private

the associated UDP L4 protocol

Definition at line 53 of file udp-socket-factory-impl.h.

Referenced by ~UdpSocketFactoryImpl(), CreateSocket(), DoDispose(), and SetUdp().

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

src/internet/model/udp-socket-factory-impl.h
src/internet/model/udp-socket-factory-impl.cc

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members