epics::pvAccess::RPCChannelProvider Class Reference

Inheritance diagram for epics::pvAccess::RPCChannelProvider:

Collaboration diagram for epics::pvAccess::RPCChannelProvider:

Public Member Functions
	POINTER_DEFINITIONS (RPCChannelProvider)
	RPCChannelProvider ()
virtual string	getProviderName ()
virtual std::tr1::shared_ptr< ChannelProvider >	getChannelProvider ()
virtual void	cancel ()
virtual void	destroy ()
virtual ChannelFind::shared_pointer	channelFind (std::string const &channelName, ChannelFindRequester::shared_pointer const &channelFindRequester)
virtual ChannelFind::shared_pointer	channelList (ChannelListRequester::shared_pointer const &channelListRequester)
virtual Channel::shared_pointer	createChannel (std::string const &channelName, ChannelRequester::shared_pointer const &channelRequester, short)
virtual Channel::shared_pointer	createChannel (std::string const &, ChannelRequester::shared_pointer const &, short, std::string const &)
void	registerService (std::string const &serviceName, RPCServiceAsync::shared_pointer const &service)
void	unregisterService (std::string const &serviceName)
Public Member Functions inherited from epics::pvAccess::ChannelProvider
	POINTER_DEFINITIONS (ChannelProvider)
	ChannelProvider ()
virtual	~ChannelProvider ()
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)
Public Member Functions inherited from epics::pvAccess::ChannelFind
	POINTER_DEFINITIONS (ChannelFind)
	ChannelFind ()
virtual	~ChannelFind ()

Static Public Attributes
static const string	PROVIDER_NAME
static const Status	noSuchChannelStatus
Static Public Attributes inherited from epics::pvAccess::ChannelProvider
static const short	PRIORITY_MIN = 0
static const short	PRIORITY_MAX = 99
static const short	PRIORITY_DEFAULT = PRIORITY_MIN
static const short	PRIORITY_LINKS_DB = PRIORITY_MAX
static const short	PRIORITY_ARCHIVE = (PRIORITY_MAX + PRIORITY_MIN) / 2
static const short	PRIORITY_OPI = PRIORITY_MIN
static size_t	num_instances

Additional Inherited Members
Public Types inherited from epics::pvAccess::ChannelFind
typedef ChannelFindRequester	requester_type
Static Public Member Functions inherited from epics::pvAccess::ChannelFind
static ChannelFind::shared_pointer	buildDummy (const std::tr1::shared_ptr< ChannelProvider > &provider)
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 243 of file rpcServer.cpp.

Constructor & Destructor Documentation

epics::pvAccess::RPCChannelProvider::RPCChannelProvider ( )

inline

Definition at line 257 of file rpcServer.cpp.

                         {
    }

Member Function Documentation

virtual void epics::pvAccess::RPCChannelProvider::cancel ( )

inlinevirtual

Implements epics::pvAccess::ChannelFind.

Definition at line 269 of file rpcServer.cpp.

{}

virtual ChannelFind::shared_pointer epics::pvAccess::RPCChannelProvider::channelFind ( std::string const &  name, ChannelFindRequester::shared_pointer const &  requester  )

inlinevirtual

Test to see if this provider has the named channel.

May call ChannelFindRequester::channelFindResult() before returning, or at some time later. If an exception is thrown, then channelFindResult() will never be called.

Parameters

name	The channel name.
requester	The Requester.

Returns

An unique()==true handle for the pending response. May only return NULL if channelFindResult() called with an Error

Implements epics::pvAccess::ChannelProvider.

Definition at line 273 of file rpcServer.cpp.

    {
        bool found;
        {
            Lock guard(m_mutex);
            found = (m_services.find(channelName) != m_services.end()) ||
                    findWildService(channelName);
        }
        ChannelFind::shared_pointer thisPtr(shared_from_this());
        channelFindRequester->channelFindResult(Status::Ok, thisPtr, found);
        return thisPtr;
    }

virtual ChannelFind::shared_pointer epics::pvAccess::RPCChannelProvider::channelList ( ChannelListRequester::shared_pointer const &  requester )

inlinevirtual

Request a list of all valid channel names for this provider.

May call ChannelListRequester::channelListResult() before returning, or at some time later. If an exception is thrown, then channelListResult() will never be called.

Parameters

requester

The Requester.

Returns

An unique()==true handle for the pending response. May only return NULL if channelFindResult() called with an Error

Reimplemented from epics::pvAccess::ChannelProvider.

Definition at line 288 of file rpcServer.cpp.

    {
        if (!channelListRequester.get())
            throw std::runtime_error("null requester");

        PVStringArray::svector channelNames;
        {
            Lock guard(m_mutex);
            channelNames.reserve(m_services.size());
            for (RPCServiceMap::const_iterator iter = m_services.begin();
                    iter != m_services.end();
                    iter++)
                channelNames.push_back(iter->first);
        }

        ChannelFind::shared_pointer thisPtr(shared_from_this());
        channelListRequester->channelListResult(Status::Ok, thisPtr, freeze(channelNames), false);
        return thisPtr;
    }

virtual Channel::shared_pointer epics::pvAccess::RPCChannelProvider::createChannel ( std::string const &  name, ChannelRequester::shared_pointer const &  requester, short  priority  )

inlinevirtual

See longer form

Reimplemented from epics::pvAccess::ChannelProvider.

Definition at line 309 of file rpcServer.cpp.

    {
        RPCServiceAsync::shared_pointer service;

        RPCServiceMap::const_iterator iter;
        {
            Lock guard(m_mutex);
            iter = m_services.find(channelName);
        }
        if (iter != m_services.end())
            service = iter->second;

        // check for wild services
        if (!service)
            service = findWildService(channelName);

        if (!service)
        {
            Channel::shared_pointer nullChannel;
            channelRequester->channelCreated(noSuchChannelStatus, nullChannel);
            return nullChannel;
        }

        // TODO use std::make_shared
        std::tr1::shared_ptr<RPCChannel> tp(
            new RPCChannel(
                shared_from_this(),
                channelName,
                channelRequester,
                service));
        Channel::shared_pointer rpcChannel = tp;
        channelRequester->channelCreated(Status::Ok, rpcChannel);
        return rpcChannel;
    }

virtual Channel::shared_pointer epics::pvAccess::RPCChannelProvider::createChannel ( std::string const &  name, ChannelRequester::shared_pointer const &  requester, short  priority, std::string const &  address  )

inlinevirtual

Request a Channel.

Channel creation is immediate. ChannelRequester::channelCreated() will be called before returning. The shared_ptr which is passed to channelCreated() will also be returned.

Failures during channel creation are delivered to ChannelRequester::channelCreated() with Status::isSuccess()==false.

Postcondition

The returned Channel will hold a strong reference to the provided ChannelRequester and to the ChannelProvider through which it is created.

The shared_ptr passed to ChannelRequester::channelCreated() is unique. See providers_ownership_unique

The new Channel will not hold a strong reference to this ChannelProvider. This provider must be kept alive in order to keep the Channel from being destoryed.

Parameters

name	The name of the channel.
requester	Will receive notifications about channel state changes
priority	channel priority, must be PRIORITY_MIN <= priority <= PRIORITY_MAX.
address	Implementation dependent condition. eg. A network address to bypass the search phase. Pass an empty() string for default behavour.

Returns

A non-NULL Channel unless channelCreated() called with an Error

Implements epics::pvAccess::ChannelProvider.

Definition at line 347 of file rpcServer.cpp.

    {
        // this will never get called by the pvAccess server
        throw std::runtime_error("not supported");
    }

virtual void epics::pvAccess::RPCChannelProvider::destroy ( )

inlinevirtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 271 of file rpcServer.cpp.

{}

virtual std::tr1::shared_ptr<ChannelProvider> epics::pvAccess::RPCChannelProvider::getChannelProvider ( )

inlinevirtual

Implements epics::pvAccess::ChannelFind.

Definition at line 264 of file rpcServer.cpp.

    {
        return shared_from_this();
    }

virtual string epics::pvAccess::RPCChannelProvider::getProviderName ( )

inlinevirtual

Get the provider name.

Returns

The name.

Implements epics::pvAccess::ChannelProvider.

Definition at line 260 of file rpcServer.cpp.

                                     {
        return PROVIDER_NAME;
    }

epics::pvAccess::RPCChannelProvider::POINTER_DEFINITIONS

(

RPCChannelProvider

)

void epics::pvAccess::RPCChannelProvider::registerService ( std::string const &  serviceName, RPCServiceAsync::shared_pointer const &  service  )

inline

Definition at line 357 of file rpcServer.cpp.

    {
        Lock guard(m_mutex);
        m_services[serviceName] = service;

        if (isWildcardPattern(serviceName))
            m_wildServices.push_back(std::make_pair(serviceName, service));
    }

void epics::pvAccess::RPCChannelProvider::unregisterService ( std::string const &  serviceName )

inline

Definition at line 366 of file rpcServer.cpp.

    {
        Lock guard(m_mutex);
        m_services.erase(serviceName);

        if (isWildcardPattern(serviceName))
        {
            for (RPCWildServiceList::iterator iter = m_wildServices.begin();
                    iter != m_wildServices.end();
                    iter++)
                if (iter->first == serviceName)
                {
                    m_wildServices.erase(iter);
                    break;
                }
        }
    }

Member Data Documentation

const Status epics::pvAccess::RPCChannelProvider::noSuchChannelStatus

static

Definition at line 253 of file rpcServer.cpp.

const string epics::pvAccess::RPCChannelProvider::PROVIDER_NAME

static

Definition at line 251 of file rpcServer.cpp.

---

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

• modules/pvAccess/src/rpcService/rpcServer.cpp