pvas::StaticProvider Class Reference

A Provider based on a list of SharedPV instance. More...

#include "server.h"

Classes
struct	ChannelBuilder
	Interface for something which can provide Channels. aka A "PV". Typically a SharedPV. More...
struct	Impl

Public Types
typedef builders_t::const_iterator	const_iterator

Public Member Functions
	POINTER_DEFINITIONS (StaticProvider)
	StaticProvider (const std::string &name)
	~StaticProvider ()
void	close (bool destroy=false)
void	add (const std::string &name, const std::tr1::shared_ptr< ChannelBuilder > &builder)
	Add a PV (eg. SharedPV) to this provider. More...
std::tr1::shared_ptr< ChannelBuilder >	remove (const std::string &name)
std::tr1::shared_ptr< epics::pvAccess::ChannelProvider >	provider () const
	Fetch the underlying ChannelProvider. Usually to build a ServerContext around. More...
const_iterator	begin () const
const_iterator	end () const

Detailed Description

A Provider based on a list of SharedPV instance.

SharedPV instances may be added/removed at any time. So it is only "static" in the sense that the list of PV names is known to StaticProvider at all times.

See also

Server API shared_ptr Ownership

Definition at line 105 of file server.h.

Member Typedef Documentation

typedef builders_t::const_iterator pvas::StaticProvider::const_iterator

Definition at line 128 of file server.h.

Constructor & Destructor Documentation

pvas::StaticProvider::StaticProvider ( const std::string &  name )

explicit

Build a new, empty, provider.

Parameters

name	Provider Name. Only relevant if registerAsServer() is called, then must be unique in this process.

Definition at line 117 of file server.cpp.

    :impl(new Impl(name))
{
    impl->internal_self = impl;
    impl->finder = pva::ChannelFind::buildDummy(impl);
    // wrap ref to call destroy when all external refs (from DyamicProvider::impl) are released.
    impl.reset(impl.get(), pva::Destroyable::cleaner(impl));
    impl->external_self = impl;
}

pvas::StaticProvider::~StaticProvider

(

)

Definition at line 127 of file server.cpp.

{ close(true); }

Member Function Documentation

void pvas::StaticProvider::add	(	const std::string &	name,
		const std::tr1::shared_ptr< ChannelBuilder > &	builder
	)

Add a PV (eg. SharedPV) to this provider.

Definition at line 150 of file server.cpp.

{
    Guard G(impl->mutex);
    if(impl->builders.find(name)!=impl->builders.end())
        throw std::logic_error("Duplicate PV name");
    impl->builders[name] = builder;
}

StaticProvider::builders_t::const_iterator pvas::StaticProvider::begin

(

)

const

Definition at line 175 of file server.cpp.

                                                                   {
    Guard G(impl->mutex);
    return impl->builders.begin();
}

void pvas::StaticProvider::close

(

bool

destroy = false

)

Call Channelbuilder::close(destroy) for all currently added ChannelBuilders.

See also

SharedPV::close()

Note

Provider locking rules apply (

See also

provider_roles_requester_locking).

Definition at line 129 of file server.cpp.

{
    Impl::builders_t pvs;
    {
        Guard G(impl->mutex);
        if(destroy) {
            pvs.swap(impl->builders); // consume
        } else {
            pvs = impl->builders; // just copy, close() is a relatively rare action
        }
    }
    for(Impl::builders_t::iterator it(pvs.begin()), end(pvs.end()); it!=end; ++it) {
        it->second->disconnect(destroy, impl.get());
    }
}

StaticProvider::builders_t::const_iterator pvas::StaticProvider::end

(

)

const

Definition at line 180 of file server.cpp.

                                                                 {
    Guard G(impl->mutex);
    return impl->builders.end();
}

pvas::StaticProvider::POINTER_DEFINITIONS

(

StaticProvider

)

std::tr1::shared_ptr< epics::pvAccess::ChannelProvider > pvas::StaticProvider::provider

(

)

const

Fetch the underlying ChannelProvider. Usually to build a ServerContext around.

Definition at line 145 of file server.cpp.

{
    return Impl::shared_pointer(impl->internal_self);
}

std::tr1::shared_ptr< StaticProvider::ChannelBuilder > pvas::StaticProvider::remove

(

const std::string &

name

)

Remove a PV. Closes any open Channels to it.

Returns

the PV which has been removed.

Note

Provider locking rules apply (

See also

provider_roles_requester_locking).

Definition at line 159 of file server.cpp.

{
    std::tr1::shared_ptr<StaticProvider::ChannelBuilder> ret;
    {
        Guard G(impl->mutex);
        Impl::builders_t::iterator it(impl->builders.find(name));
        if(it!=impl->builders.end()) {
            ret = it->second;
            impl->builders.erase(it);
        }
    }
    if(ret)
        ret->disconnect(true, impl.get());
    return ret;
}

---

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

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