#include "pvAccess.h"

Public Types
typedef std::vector< std::string >	stringVector_t

typedef std::set< std::string >	provider_name_set

typedef ChannelProvider::shared_pointer(*	factoryfn_t) (const std::tr1::shared_ptr< Configuration > &)

Public Member Functions
	POINTER_DEFINITIONS (ChannelProviderRegistry)

virtual	~ChannelProviderRegistry ()

ChannelProvider::shared_pointer	getProvider (std::string const &providerName)

ChannelProvider::shared_pointer	createProvider (std::string const &providerName, const std::tr1::shared_ptr< Configuration > &conf=std::tr1::shared_ptr< Configuration >())

virtual ChannelProviderFactory::shared_pointer	getFactory (std::string const &providerName)

virtual void	getProviderNames (provider_name_set &names)

virtual bool	add (const ChannelProviderFactory::shared_pointer &fact, bool replace=true)

template<class Provider >
ChannelProviderFactory::shared_pointer	add (const std::string &name, bool replace=true)
	Add a new Provider which will be built using SimpleChannelProviderFactory<Provider> More...

ChannelProviderFactory::shared_pointer	add (const std::string &name, factoryfn_t, bool replace=true)

template<class Provider >
ChannelProviderFactory::shared_pointer	addSingleton (const std::string &name, const std::tr1::shared_ptr< const Configuration > &conf=std::tr1::shared_ptr< const Configuration >(), bool replace=true)
	Add a new Provider which will be built using SingletonChannelProviderFactory<Provider> More...

ChannelProviderFactory::shared_pointer	addSingleton (const ChannelProvider::shared_pointer &provider, bool replace=true)

ChannelProviderFactory::shared_pointer	remove (const std::string &name)
	Attempt to remove a factory with the given name. Return Factory which was removed, or NULL if not found. More...

virtual bool	remove (const ChannelProviderFactory::shared_pointer &factory)
	Attempt to remove a factory. Return true if Factory was previously registered, and now removed. More...

virtual void	clear ()
	Drop all factories. More...

Static Public Member Functions
static ChannelProviderRegistry::shared_pointer	build ()
	Create a custom registry. More...

static ChannelProviderRegistry::shared_pointer	clients ()

static ChannelProviderRegistry::shared_pointer	servers ()

Friends
struct	CompatRegistry

Detailed Description

Interface for locating channel providers.

Definition at line 1433 of file pvAccess.h.

Member Typedef Documentation

typedef ChannelProvider::shared_pointer(* epics::pvAccess::ChannelProviderRegistry::factoryfn_t) (const std::tr1::shared_ptr< Configuration > &)

Definition at line 1496 of file pvAccess.h.

typedef std::set<std::string> epics::pvAccess::ChannelProviderRegistry::provider_name_set

Definition at line 1477 of file pvAccess.h.

typedef std::vector<std::string> epics::pvAccess::ChannelProviderRegistry::stringVector_t

Definition at line 1437 of file pvAccess.h.

Constructor & Destructor Documentation

virtual epics::pvAccess::ChannelProviderRegistry::~ChannelProviderRegistry ( )

inlinevirtual

Definition at line 1439 of file pvAccess.h.

1439 {}

Member Function Documentation

bool epics::pvAccess::ChannelProviderRegistry::add	(	const ChannelProviderFactory::shared_pointer &	fact,
		bool	replace = `true`
	)

virtual

Add new factory. if replace=false and name already in use, return false with no change in other cases insert provided factory and return true.

Definition at line 81 of file ChannelAccessFactory.cpp.

 {
     assert(fact);
     Lock G(mutex);
     std::string name(fact->getFactoryName());
     if(!replace && providers.find(name)!=providers.end())
         return false;
     providers[name] = fact;
     return true;
 }

template<class Provider >

ChannelProviderFactory::shared_pointer epics::pvAccess::ChannelProviderRegistry::add	(	const std::string &	name,
		bool	replace = `true`
	)

inline

Add a new Provider which will be built using SimpleChannelProviderFactory<Provider>

Definition at line 1489 of file pvAccess.h.

     {
         typedef SimpleChannelProviderFactory<Provider> Factory;
         typename Factory::shared_pointer fact(new Factory(name));
         return add(fact, replace) ? fact : typename Factory::shared_pointer();
     }

ChannelProviderFactory::shared_pointer epics::pvAccess::ChannelProviderRegistry::add	(	const std::string &	name,
		factoryfn_t	fn,
		bool	replace = `true`
	)

Definition at line 124 of file ChannelAccessFactory.cpp.

 {
     ChannelProviderFactory::shared_pointer F(new FunctionFactory(name, fn));
     return add(F, replace) ? F : ChannelProviderFactory::shared_pointer();
 }

template<class Provider >

ChannelProviderFactory::shared_pointer epics::pvAccess::ChannelProviderRegistry::addSingleton	(	const std::string &	name,
		const std::tr1::shared_ptr< const Configuration > &	conf = `std::tr1::shared_ptr<const Configuration>()`,
		bool	replace = `true`
	)

inline

Add a new Provider which will be built using SingletonChannelProviderFactory<Provider>

Definition at line 1502 of file pvAccess.h.

     {
         typedef SingletonChannelProviderFactory<Provider> Factory;
         typename Factory::shared_pointer fact(new Factory(name, conf));
         return add(fact, replace) ? fact : typename Factory::shared_pointer();
     }

ChannelProviderFactory::shared_pointer epics::pvAccess::ChannelProviderRegistry::addSingleton	(	const ChannelProvider::shared_pointer &	provider,
		bool	replace = `true`
	)

Add a pre-created Provider instance. Only a weak ref to this instance is kept, so the instance must be kept active through some external means

Since: 6.1.0

Definition at line 159 of file ChannelAccessFactory.cpp.

 {
     std::tr1::shared_ptr<InstanceChannelProviderFactory> F(new InstanceChannelProviderFactory(provider));
     return add(F, replace) ? F : std::tr1::shared_ptr<InstanceChannelProviderFactory>();
 }

ChannelProviderRegistry::shared_pointer epics::pvAccess::ChannelProviderRegistry::build ( )

static

Create a custom registry.

Definition at line 40 of file ChannelAccessFactory.cpp.

                                                                      {
     ChannelProviderRegistry::shared_pointer ret(new ChannelProviderRegistry);
     return ret;
 }

void epics::pvAccess::ChannelProviderRegistry::clear ( )

virtual

Drop all factories.

Definition at line 188 of file ChannelAccessFactory.cpp.

 {
     Lock G(mutex);
     providers.clear();
 }

ChannelProviderRegistry::shared_pointer epics::pvAccess::ChannelProviderRegistry::clients ( )

static

The global registry for "clients". Register providers which will be used within this process. Typically providers which access data outside of the process. Associated with EPICS_PVA_PROVIDER_NAMES

Definition at line 235 of file ChannelAccessFactory.cpp.

 {
     epicsThreadOnce(&providerRegOnce, &providerRegInit, 0);
 
     return providerRegGbl->clients;
 }

ChannelProvider::shared_pointer epics::pvAccess::ChannelProviderRegistry::createProvider	(	std::string const &	providerName,
		const std::tr1::shared_ptr< Configuration > &	conf = `std::tr1::shared_ptr<Configuration>()`
	)

Creates a new instanceof the provider with the specified name.

Parameters

providerName The name of the provider.

Returns: The interface for the provider or null if the provider is not known.

Definition at line 53 of file ChannelAccessFactory.cpp.

                                                                                                                      {
     ChannelProviderFactory::shared_pointer fact(getFactory(providerName));
     if(fact)
         return fact->newInstance(conf);
     else
         return ChannelProvider::shared_pointer();
 }

ChannelProviderFactory::shared_pointer epics::pvAccess::ChannelProviderRegistry::getFactory ( std::string const & providerName )

virtual

Fetch provider factor with the specified name.

Parameters

providerName The name of the provider.

Returns: The factor or null if the provider is not known.

Definition at line 62 of file ChannelAccessFactory.cpp.

 {
     Lock G(mutex);
     providers_t::const_iterator iter = providers.find(providerName);
     if (iter == providers.end())
         return ChannelProviderFactory::shared_pointer();
     else
         return iter->second;
 }

ChannelProvider::shared_pointer epics::pvAccess::ChannelProviderRegistry::getProvider ( std::string const & providerName )

Get a shared instance of the provider with the specified name.

Parameters

providerName The name of the provider.

Returns: The interface for the provider or null if the provider is not known.

Definition at line 45 of file ChannelAccessFactory.cpp.

                                                                                                  {
     ChannelProviderFactory::shared_pointer fact(getFactory(providerName));
     if(fact)
         return fact->sharedInstance();
     else
         return ChannelProvider::shared_pointer();
 }

void epics::pvAccess::ChannelProviderRegistry::getProviderNames ( provider_name_set & names )

virtual

Find currently registered provider names.

Definition at line 72 of file ChannelAccessFactory.cpp.

 {
     Lock G(mutex);
     for (providers_t::const_iterator iter = providers.begin();
          iter != providers.end(); iter++)
         names.insert(iter->first);
 }

epics::pvAccess::ChannelProviderRegistry::POINTER_DEFINITIONS ( ChannelProviderRegistry )

ChannelProviderFactory::shared_pointer epics::pvAccess::ChannelProviderRegistry::remove ( const std::string & name )

Attempt to remove a factory with the given name. Return Factory which was removed, or NULL if not found.

Definition at line 166 of file ChannelAccessFactory.cpp.

 {
     Lock G(mutex);
     ChannelProviderFactory::shared_pointer fact(getFactory(name));
     if(fact) {
         remove(fact);
     }
     return fact;
 }

bool epics::pvAccess::ChannelProviderRegistry::remove ( const ChannelProviderFactory::shared_pointer & factory )

virtual

Attempt to remove a factory. Return true if Factory was previously registered, and now removed.

Definition at line 176 of file ChannelAccessFactory.cpp.

 {
     assert(fact);
     Lock G(mutex);
     providers_t::iterator iter(providers.find(fact->getFactoryName()));
     if(iter!=providers.end() && iter->second==fact) {
         providers.erase(iter);
         return true;
     }
     return false;
 }

ChannelProviderRegistry::shared_pointer epics::pvAccess::ChannelProviderRegistry::servers ( )

static

The global registry for "servers". Register providers which will be used outside of this process (via ServerContext). Typically providers which access data within the process. Associated with EPICS_PVAS_PROVIDER_NAMES

Definition at line 242 of file ChannelAccessFactory.cpp.

 {
     epicsThreadOnce(&providerRegOnce, &providerRegInit, 0);
 
     return providerRegGbl->servers;
 }

Friends And Related Function Documentation

friend struct CompatRegistry

friend

Definition at line 1531 of file pvAccess.h.

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

modules/pvAccess/src/client/pv/pvAccess.h
modules/pvAccess/src/factory/ChannelAccessFactory.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation