A Discrete-Event Network Simulator
API
ns3::SocketFactory Class Referenceabstract

Object to create transport layer instances that provide a socket API to applications. More...

#include "socket-factory.h"

+ Inheritance diagram for ns3::SocketFactory:
+ Collaboration diagram for ns3::SocketFactory:

Public Member Functions

 SocketFactory ()
 
virtual Ptr< SocketCreateSocket ()=0
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::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 (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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 errors. 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...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 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 ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Object to create transport layer instances that provide a socket API to applications.

This base class defines the API for creating sockets. The socket factory also can hold the global variables used to initialize newly created sockets, such as values that are set through the sysctl or proc interfaces in Linux.

If you want to write a new transport protocol accessible through sockets, you need to subclass this factory class, implement CreateSocket, instantiate the object, and aggregate it to the node.

See also
Udp
UdpImpl

Definition at line 48 of file socket-factory.h.

Constructor & Destructor Documentation

◆ SocketFactory()

ns3::SocketFactory::SocketFactory ( )

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ CreateSocket()

virtual Ptr<Socket> ns3::SocketFactory::CreateSocket ( )
pure virtual
Returns
smart pointer to Socket

Base class method for creating socket instances.

Implemented in ns3::PacketSocketFactory, ns3::UdpSocketFactoryImpl, ns3::TcpSocketFactoryImpl, ns3::Ipv6RawSocketFactoryImpl, and ns3::Ipv4RawSocketFactoryImpl.

Referenced by Ipv4DeduplicationTest::DoRun().

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::SocketFactory::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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