rsb::transport::ConnectorFactory< Interface > Class Template Reference

Objects of this class are specialized factories that construct Connector objects and provide introspection for connector implementations without instantiating them. More...

#include <Factory.h>

Inheritance diagram for rsb::transport::ConnectorFactory< Interface >:

Collaboration diagram for rsb::transport::ConnectorFactory< Interface >:

Classes
class	ConnectorInfo
	Instances of this class describe capabilities and properties of connector implementations. More...

Public Member Functions
	ConnectorFactory ()
ConnectorInfo	getConnectorInfo (const std::string &name) const
	Return information regarding the connector implementation named name. More...
std::set< ConnectorInfo >	getConnectorInfos () const
void	registerConnector (const std::string &name, const CreateFunction &constructor, const std::set< std::string > &schemas=std::set< std::string >(), bool remote=true, const std::set< std::string > &options=std::set< std::string >())
	For the connector implementation named name, register the construct function constructor, supported schemas schemas and recognized configuration options options. More...
void	registerConnector (const std::string &name, const CreateFunction &constructor, const std::string &schema, bool remote=true, const std::set< std::string > &options=std::set< std::string >())

Private Types
typedef rsc::patterns::Factory< std::string, Interface >	Factory
typedef Factory::CreateFunction	CreateFunction
typedef Factory::ImplMapProxy	ImplMapProxy
typedef std::map< std::string, ConnectorInfo >	InfoMap

Private Member Functions
void	printContents (std::ostream &stream) const

Private Attributes
rsc::logging::LoggerPtr	logger
InfoMap	infos

Friends
InPullFactory &	getInPullFactory ()
InPushFactory &	getInPushFactory ()
OutFactory &	getOutFactory ()

Detailed Description

template<typename Interface>
class rsb::transport::ConnectorFactory< Interface >

Objects of this class are specialized factories that construct Connector objects and provide introspection for connector implementations without instantiating them.

Author

jmoringe

Definition at line 52 of file Factory.h.

Member Typedef Documentation

template<typename Interface >

typedef Factory::CreateFunction rsb::transport::ConnectorFactory< Interface >::CreateFunction

private

Definition at line 172 of file Factory.h.

template<typename Interface >

typedef rsc::patterns::Factory<std::string, Interface> rsb::transport::ConnectorFactory< Interface >::Factory

private

Definition at line 171 of file Factory.h.

template<typename Interface >

typedef Factory::ImplMapProxy rsb::transport::ConnectorFactory< Interface >::ImplMapProxy

private

Definition at line 173 of file Factory.h.

template<typename Interface >

typedef std::map<std::string, ConnectorInfo> rsb::transport::ConnectorFactory< Interface >::InfoMap

private

Definition at line 174 of file Factory.h.

Constructor & Destructor Documentation

template<typename Interface >

rsb::transport::ConnectorFactory< Interface >::ConnectorFactory ( )

inline

Definition at line 176 of file Factory.h.

Member Function Documentation

template<typename Interface >

ConnectorInfo rsb::transport::ConnectorFactory< Interface >::getConnectorInfo ( const std::string &  name ) const

inline

Return information regarding the connector implementation named name.

Parameters

name	Name of the implementation for which information should be returned.

Returns

A ConnectorInfo object.

Exceptions

rsc::runtime::NoSuchObject

If a record for name cannot be found.

Definition at line 189 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::infos.

Referenced by rsb::transport::isAvailable(), rsb::transport::isRemote(), and rsb::transport::ConnectorFactory< Interface >::printContents().

Here is the caller graph for this function:

template<typename Interface >

std::set<ConnectorInfo> rsb::transport::ConnectorFactory< Interface >::getConnectorInfos ( ) const

inline

Definition at line 197 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::infos.

Referenced by rsb::transport::getAvailableTransports().

Here is the caller graph for this function:

template<typename Interface >

void rsb::transport::ConnectorFactory< Interface >::printContents ( std::ostream &  stream ) const

inlineprivate

Definition at line 245 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::getConnectorInfo().

Here is the call graph for this function:

template<typename Interface >

void rsb::transport::ConnectorFactory< Interface >::registerConnector ( const std::string &  name, const CreateFunction &  constructor, const std::set< std::string > &  schemas = std::set<std::string>(), bool  remote = true, const std::set< std::string > &  options = std::set<std::string>()  )

inline

For the connector implementation named name, register the construct function constructor, supported schemas schemas and recognized configuration options options.

Parameters

name	Name of the connector implementation.
constructor	Construct function.
schemas	A list of strings designating schemas supported by the implementation.
options	A list of strings describing configuration options recognized by the implementation.

Definition at line 219 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::infos, rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::options, rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::remote, and rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::schemas.

Referenced by rsb::transport::ConnectorFactory< Interface >::registerConnector(), and rsb::transport::registerDefaultTransports().

Here is the caller graph for this function:

template<typename Interface >

void rsb::transport::ConnectorFactory< Interface >::registerConnector ( const std::string &  name, const CreateFunction &  constructor, const std::string &  schema, bool  remote = true, const std::set< std::string > &  options = std::set<std::string>()  )

inline

Definition at line 234 of file Factory.h.

References rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::options, rsb::transport::ConnectorFactory< Interface >::registerConnector(), rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::remote, and rsb::transport::ConnectorFactory< Interface >::ConnectorInfo::schemas.

Here is the call graph for this function:

Friends And Related Function Documentation

template<typename Interface >

InPullFactory& getInPullFactory ( )

friend

Definition at line 32 of file Factory.cpp.

template<typename Interface >

InPushFactory& getInPushFactory ( )

friend

Definition at line 37 of file Factory.cpp.

template<typename Interface >

OutFactory& getOutFactory ( )

friend

Definition at line 42 of file Factory.cpp.

Member Data Documentation

template<typename Interface >

InfoMap rsb::transport::ConnectorFactory< Interface >::infos

private

Definition at line 243 of file Factory.h.

Referenced by rsb::transport::ConnectorFactory< Interface >::getConnectorInfo(), rsb::transport::ConnectorFactory< Interface >::getConnectorInfos(), and rsb::transport::ConnectorFactory< Interface >::registerConnector().

template<typename Interface >

rsc::logging::LoggerPtr rsb::transport::ConnectorFactory< Interface >::logger

private

Definition at line 165 of file Factory.h.

---

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

• rsb/transport/Factory.h