kanzi::connect::ConnectionAdapterObjectFactory Class Reference

Connection adapter factory interface. More...

#include <connection_adapter_factory.hpp>

Classes
struct	FactoryTriple

Public Types
typedef function< ConnectionAdapterSharedPtr(ClientIdManager &clientIdManager)	ConnectionAdapterCreateFunc)
typedef function< ConnectionAdapter::Parameters()>	ConnectionAdapterParametersCreateFunc
typedef map< string, shared_ptr< FactoryTriple > >	FactoryContainer
typedef struct kanzi::connect::ConnectionAdapterObjectFactory::FactoryTriple	FactoryTriple

Public Member Functions
	ConnectionAdapterObjectFactory ()
	C++ constructor.
ConnectionAdapterSharedPtr	createAdapterInstance (const string &identifier, ClientIdManager &clientIdManager)
	Instantiate adapter of specified type.
ConnectionAdapter::Parameters	createDefaultAdapterParameters (const string &identifier)
	Instantiate default parameters for given type adapter.
ConnectionAdapter::Parameters	createP2PAdapterParameters (const string &identifier)
	Instantiate default parameters for given type adapter.
ConnectDomainSharedPtr	getDomain () const
	Retrieve the connect domain.
void	registerAdapterType (const string &identifier, ConnectionAdapterCreateFunc createFunc, ConnectionAdapter::Parameters defaultParameters=ConnectionAdapter::Parameters(), ConnectionAdapter::Parameters p2pParameters=ConnectionAdapter::Parameters())
	Register new adapter type.
void	setDomain (ConnectDomainSharedPtr domain)
	Store the domain where factory operates in.
void	unregisterAdapterType (const string &identifier)
	Unregisters given adapter type.

Detailed Description

Connection adapter factory interface.

Member Typedef Documentation

ConnectionAdapterCreateFunc

typedef function<ConnectionAdapterSharedPtr(ClientIdManager& clientIdManager) kanzi::connect::ConnectionAdapterObjectFactory::ConnectionAdapterCreateFunc)

ConnectionAdapterParametersCreateFunc

typedef function<ConnectionAdapter::Parameters()> kanzi::connect::ConnectionAdapterObjectFactory::ConnectionAdapterParametersCreateFunc

FactoryContainer

typedef map<string, shared_ptr<FactoryTriple> > kanzi::connect::ConnectionAdapterObjectFactory::FactoryContainer

FactoryTriple

typedef struct kanzi::connect::ConnectionAdapterObjectFactory::FactoryTriple kanzi::connect::ConnectionAdapterObjectFactory::FactoryTriple

Constructor & Destructor Documentation

ConnectionAdapterObjectFactory()

kanzi::connect::ConnectionAdapterObjectFactory::ConnectionAdapterObjectFactory

(

)

C++ constructor.

Member Function Documentation

createAdapterInstance()

ConnectionAdapterSharedPtr kanzi::connect::ConnectionAdapterObjectFactory::createAdapterInstance ( const string & identifier, ClientIdManager & clientIdManager )

inline

Instantiate adapter of specified type.

Returns

newly allocated adapter.

createDefaultAdapterParameters()

ConnectionAdapter::Parameters kanzi::connect::ConnectionAdapterObjectFactory::createDefaultAdapterParameters ( const string & identifier )

inline

Instantiate default parameters for given type adapter.

Returns

newly allocated parameters for given adapter type.

createP2PAdapterParameters()

ConnectionAdapter::Parameters kanzi::connect::ConnectionAdapterObjectFactory::createP2PAdapterParameters ( const string & identifier )

inline

Instantiate default parameters for given type adapter.

Returns

newly allocated parameters for given adapter type.

getDomain()

ConnectDomainSharedPtr kanzi::connect::ConnectionAdapterObjectFactory::getDomain

(

)

const

Retrieve the connect domain.

Returns

the domain where factory operates in. ownership not transfered.

registerAdapterType()

void kanzi::connect::ConnectionAdapterObjectFactory::registerAdapterType ( const string & identifier, ConnectionAdapterCreateFunc createFunc, ConnectionAdapter::Parameters defaultParameters = ConnectionAdapter::Parameters(), ConnectionAdapter::Parameters p2pParameters = ConnectionAdapter::Parameters() )

inline

Register new adapter type.

Parameters

createFunc

function object to invoke in order to create instance of adapter

setDomain()

void kanzi::connect::ConnectionAdapterObjectFactory::setDomain

(

ConnectDomainSharedPtr

domain

)

Store the domain where factory operates in.

Parameters

domain

the operating domain. ownership not transfered.

unregisterAdapterType()

void kanzi::connect::ConnectionAdapterObjectFactory::unregisterAdapterType ( const string & identifier )

inline

Unregisters given adapter type.

---

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

• connect/connection/connection_adapter_factory.hpp