A Discrete-Event Network Simulator
API
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< SocketCreateSocket (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 ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. 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
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Protected Member Functions

virtual void DoDispose (void)
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Attributes

Ptr< UdpL4Protocolm_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)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. 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.

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

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

Constructor & Destructor Documentation

◆ UdpSocketFactoryImpl()

ns3::UdpSocketFactoryImpl::UdpSocketFactoryImpl ( )

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

◆ ~UdpSocketFactoryImpl()

ns3::UdpSocketFactoryImpl::~UdpSocketFactoryImpl ( )
virtual

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

References m_udp, and NS_ASSERT.

Member Function Documentation

◆ CreateSocket()

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.

Returns
smart pointer to Socket

Implements ns3::SocketFactory.

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

References m_udp.

◆ DoDispose()

void ns3::UdpSocketFactoryImpl::DoDispose ( void  )
protectedvirtual

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 49 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
udpthe UDP L4 protocol

Definition at line 37 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 62 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: