Murl::Net::IFactory Interface Referenceabstract

The net IFactory interface. More...

#include "murl_net_i_factory.h"

Inherited by Murl::Net::Factory.

Public Member Functions

virtual Bool Init ()=0
 Initialize the factory. More...
 
virtual Bool DeInit ()=0
 Deinitialize the factory. More...
 
virtual ISocket::SharedPtr CreateSocket ()=0
 Create a socket SharedPointer object. More...
 
virtual ISocketCreateRawSocket ()=0
 Create a socket object. More...
 
virtual Bool DestroyRawSocket (ISocket *&socket)=0
 Destroy a socket object. More...
 
virtual ISocketAddressPtr CreateSocketAddress ()=0
 Create a socket address SharedPointer object. More...
 
virtual ISocketAddressCreateRawSocketAddress ()=0
 Create a socket address object. More...
 
virtual Bool DestroyRawSocketAddress (ISocketAddress *&socketAddress)=0
 Destroy a socket address object. More...
 
virtual ISocketClientCreateSocketClient (const String &clientName, const String &uniqueId)=0
 Create a socket client object. More...
 
virtual Bool DestroySocketClient (ISocketClient *&socketClient)=0
 Destroy a socket client object. More...
 
virtual ISocketPacketCreateSocketPacket ()=0
 Create a socket packet object. More...
 
virtual Bool DestroySocketPacket (ISocketPacket *&socketPacket)=0
 Destroy a socket packet object. More...
 
virtual ISocketServerCreateSocketServer (const String &serverName, const String &uniqueId)=0
 Create a socket server object. More...
 
virtual Bool DestroySocketServer (ISocketServer *&socketServer)=0
 Destroy a socket server object. More...
 

Detailed Description

The net IFactory interface.

Member Function Documentation

◆ Init()

virtual Bool Murl::Net::IFactory::Init ( )
pure virtual

Initialize the factory.

Returns
true if successful.

◆ DeInit()

virtual Bool Murl::Net::IFactory::DeInit ( )
pure virtual

Deinitialize the factory.

Returns
true if successful.

◆ CreateSocket()

virtual ISocket::SharedPtr Murl::Net::IFactory::CreateSocket ( )
pure virtual

Create a socket SharedPointer object.

Returns
The created socket SharedPointer object.

◆ CreateRawSocket()

virtual ISocket* Murl::Net::IFactory::CreateRawSocket ( )
pure virtual

Create a socket object.

Returns
The created socket object, or null if failed.

◆ DestroyRawSocket()

virtual Bool Murl::Net::IFactory::DestroyRawSocket ( ISocket *&  socket)
pure virtual

Destroy a socket object.

Parameters
socketA reference to the socket object pointer. After destruction the pointer is set to null.
Returns
true if successful.

◆ CreateSocketAddress()

virtual ISocketAddressPtr Murl::Net::IFactory::CreateSocketAddress ( )
pure virtual

Create a socket address SharedPointer object.

Returns
The created socket address SharedPointer object.

◆ CreateRawSocketAddress()

virtual ISocketAddress* Murl::Net::IFactory::CreateRawSocketAddress ( )
pure virtual

Create a socket address object.

Returns
The created socket address object, or null if failed.

◆ DestroyRawSocketAddress()

virtual Bool Murl::Net::IFactory::DestroyRawSocketAddress ( ISocketAddress *&  socketAddress)
pure virtual

Destroy a socket address object.

Alternatively the ISocketAddress object can be destroyed by using delete.

Parameters
socketAddressA reference to the socket address object pointer. After destruction the pointer is set to null.
Returns
true if successful.

◆ CreateSocketClient()

virtual ISocketClient* Murl::Net::IFactory::CreateSocketClient ( const String clientName,
const String uniqueId 
)
pure virtual

Create a socket client object.

Parameters
clientNameThe name of the client.
uniqueIdThe unique identifer of the client.
Returns
The created socket client object, or null if failed.

◆ DestroySocketClient()

virtual Bool Murl::Net::IFactory::DestroySocketClient ( ISocketClient *&  socketClient)
pure virtual

Destroy a socket client object.

Parameters
socketClientA reference to the socket client object pointer. After destruction the pointer is set to null.
Returns
true if successful.

◆ CreateSocketPacket()

virtual ISocketPacket* Murl::Net::IFactory::CreateSocketPacket ( )
pure virtual

Create a socket packet object.

Returns
The created socket packet object, or null if failed.

◆ DestroySocketPacket()

virtual Bool Murl::Net::IFactory::DestroySocketPacket ( ISocketPacket *&  socketPacket)
pure virtual

Destroy a socket packet object.

Alternatively the ISocketPacket object can be destroyed by using delete.

Parameters
socketPacketA reference to the socket packet object pointer. After destruction the pointer is set to null.
Returns
true if successful.

◆ CreateSocketServer()

virtual ISocketServer* Murl::Net::IFactory::CreateSocketServer ( const String serverName,
const String uniqueId 
)
pure virtual

Create a socket server object.

Parameters
serverNameThe name of the server.
uniqueIdThe unique identifer of the server.
Returns
The created socket server object, or null if failed.

◆ DestroySocketServer()

virtual Bool Murl::Net::IFactory::DestroySocketServer ( ISocketServer *&  socketServer)
pure virtual

Destroy a socket server object.

Parameters
socketServerA reference to the socket server object pointer. After destruction the pointer is set to null.
Returns
true if successful.

The documentation for this interface was generated from the following file:
  • murl_net_i_factory.h


Copyright © 2011-2018 Spraylight GmbH.