ns3::UdpSocketFactoryImpl Class Reference

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 ()
virtual	~UdpSocketFactoryImpl ()
virtual Ptr< Socket >	CreateSocket (void)
	Implements a method to create a Udp-based socket and return a base class smart pointer to the socket. More...
void	SetUdp (Ptr< UdpL4Protocol > udp)
	Set the associated UDP L4 protocol. More...
Public Member Functions inherited from ns3::SocketFactory
	SocketFactory ()
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...
	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...
uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. More...
void	Ref (void) const
	Increment the reference count. More...
void	Unref (void) 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
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Protected Member Functions
virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...
virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

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

Additional Inherited Members
Static Public Member Functions inherited from ns3::UdpSocketFactory
static TypeId	GetTypeId (void)
	Get the type ID. More...
Static Public Member Functions inherited from ns3::SocketFactory
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Detailed Description

Object to create UDP socket instances.

Internal:

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

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

Constructor & Destructor Documentation

ns3::UdpSocketFactoryImpl::UdpSocketFactoryImpl

(

)

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

ns3::UdpSocketFactoryImpl::~UdpSocketFactoryImpl ( )

virtual

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

References m_udp, and NS_ASSERT.

Member Function Documentation

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

virtual

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

Internal:

Returns

smart pointer to Socket

Implements ns3::SocketFactory.

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

References m_udp.

void ns3::UdpSocketFactoryImpl::DoDispose ( void  )

protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden 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 49 of file udp-socket-factory-impl.cc.

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

Here is the call graph for this function:

void ns3::UdpSocketFactoryImpl::SetUdp

(

Ptr< UdpL4Protocol >

udp

)

Set the associated UDP L4 protocol.

Parameters

udp	the UDP L4 protocol

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

References m_udp.

Member Data Documentation

Ptr<UdpL4Protocol> ns3::UdpSocketFactoryImpl::m_udp

private

the associated UDP L4 protocol

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

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

---

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