pvac::ClientProvider Class Reference

Central client context. More...

#include "client.h"

Classes
struct	Impl

Public Member Functions
	ClientProvider ()
	Construct a null provider. All methods throw. May later be assigned from a valid ClientProvider. More...
	ClientProvider (const std::string &providerName, const std::tr1::shared_ptr< epics::pvAccess::Configuration > &conf=std::tr1::shared_ptr< epics::pvAccess::Configuration >())
	ClientProvider (const std::tr1::shared_ptr< epics::pvAccess::ChannelProvider > &provider)
	~ClientProvider ()
std::string	name () const
ClientChannel	connect (const std::string &name, const ClientChannel::Options &conf=ClientChannel::Options())
bool	disconnect (const std::string &name, const ClientChannel::Options &conf=ClientChannel::Options())
	Remove from channel cache. More...
void	disconnect ()
	Clear channel cache. More...
bool	valid () const
	operator bool_type () const
void	reset ()

Friends
void	detail::registerRefTrack ()
epicsShareFunc::std::ostream &	operator<< (::std::ostream &strm, const ClientProvider &op)

Detailed Description

Central client context.

Definition at line 517 of file client.h.

Constructor & Destructor Documentation

pvac::ClientProvider::ClientProvider ( )

inline

Construct a null provider. All methods throw. May later be assigned from a valid ClientProvider.

Definition at line 526 of file client.h.

{}

pvac::ClientProvider::ClientProvider	(	const std::string &	providerName,
		const std::tr1::shared_ptr< epics::pvAccess::Configuration > &	conf = std::tr1::shared_ptr<epics::pvAccess::Configuration>()
	)

Use named provider.

Parameters

providerName

ChannelProvider name, may be prefixed with "clients:" or "servers:" to query epics::pvAccess::ChannelProviderRegistry::clients() or epics::pvAccess::ChannelProviderRegistry::servers(). No prefix implies "clients:".

Definition at line 250 of file client.cpp.

    :impl(new Impl)
{
    std::string name;
    pva::ChannelProviderRegistry::shared_pointer reg;

    if(strncmp("server:", providerName.c_str(), 7)==0) {
        name = providerName.substr(7);
        reg = pva::ChannelProviderRegistry::servers();
    } else if(strncmp("client:", providerName.c_str(), 7)==0) {
        name = providerName.substr(7);
        reg = pva::ChannelProviderRegistry::clients();
    } else {
        name = providerName;
        reg = pva::ChannelProviderRegistry::clients();
    }
    impl->provider = reg->createProvider(name,
                                         conf ? conf : pva::ConfigurationBuilder()
                                                .push_env()
                                                .build());

    if(!impl->provider)
        THROW_EXCEPTION2(std::invalid_argument, providerName);
}

pvac::ClientProvider::ClientProvider ( const std::tr1::shared_ptr< epics::pvAccess::ChannelProvider > &  provider )

explicit

Definition at line 276 of file client.cpp.

    :impl(new Impl)
{
    impl->provider = provider;

    if(!impl->provider)
        THROW_EXCEPTION2(std::invalid_argument, "null ChannelProvider");
}

pvac::ClientProvider::~ClientProvider

(

)

Definition at line 285 of file client.cpp.

{}

Member Function Documentation

ClientChannel pvac::ClientProvider::connect	(	const std::string &	name,
		const ClientChannel::Options &	conf = ClientChannel::Options()
	)

Get a new Channel

Does not block. Never returns NULL. Uses internal Channel cache.

Definition at line 295 of file client.cpp.

{
    if(!impl) throw std::logic_error("Dead Provider");
    Guard G(impl->mutex);
    Impl::channels_t::key_type K(name, conf);
    Impl::channels_t::iterator it(impl->channels.find(K));
    if(it!=impl->channels.end()) {
        // cache hit
        std::tr1::shared_ptr<ClientChannel::Impl> chan(it->second.lock());
        if(chan)
            return ClientChannel(chan);
        else
            impl->channels.erase(it); // remove stale
    }
    // cache miss
    ClientChannel ret(impl->provider, name, conf);
    impl->channels[K] = ret.impl;
    return ret;
}

bool pvac::ClientProvider::disconnect	(	const std::string &	name,
		const ClientChannel::Options &	conf = ClientChannel::Options()
	)

Remove from channel cache.

Definition at line 316 of file client.cpp.

{
    if(!impl) throw std::logic_error("Dead Provider");
    Guard G(impl->mutex);

    Impl::channels_t::iterator it(impl->channels.find(std::make_pair(name, conf)));
    bool found = it!=impl->channels.end();
    if(found)
        impl->channels.erase(it);
    return found;
}

void pvac::ClientProvider::disconnect

(

)

Clear channel cache.

Definition at line 329 of file client.cpp.

{
    if(!impl) throw std::logic_error("Dead Provider");
    Guard G(impl->mutex);
    impl->channels.clear();
}

std::string pvac::ClientProvider::name

(

)

const

Definition at line 288 of file client.cpp.

{
    if(!impl) throw std::logic_error("Dead Provider");
    return impl->provider->getProviderName();
}

pvac::ClientProvider::operator bool_type ( ) const

inline

Definition at line 565 of file client.h.

{ return valid() ? &ClientProvider::valid : 0; }

void pvac::ClientProvider::reset ( )

inline

Definition at line 568 of file client.h.

{ impl.reset(); }

bool pvac::ClientProvider::valid ( void  ) const

inline

Definition at line 557 of file client.h.

{ return !!impl; }

Friends And Related Function Documentation

void detail::registerRefTrack ( )

friend

epicsShareFunc ::std::ostream& operator<< ( ::std::ostream &  strm, const ClientProvider &  op  )

friend

Definition at line 361 of file client.cpp.

{
    if(op.impl) {
        strm << "ClientProvider("
             << typeid(*op.impl->provider.get()).name()<<", "
                "\""<<op.impl->provider->getProviderName()<<"\")";
    } else {
        strm << "ClientProvider()";
    }
    return strm;
}

---

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

• modules/pvAccess/src/client/pva/client.h
• modules/pvAccess/src/client/client.cpp