epics::pvAccess::ca::CAChannelProvider Class Reference

#include "caProviderPvt.h"

Inheritance diagram for epics::pvAccess::ca::CAChannelProvider:

Collaboration diagram for epics::pvAccess::ca::CAChannelProvider:

Public Member Functions
	POINTER_DEFINITIONS (CAChannelProvider)
	CAChannelProvider ()
	CAChannelProvider (const std::tr1::shared_ptr< Configuration > &)
virtual	~CAChannelProvider ()
virtual std::string	getProviderName ()
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 priority)
virtual Channel::shared_pointer	createChannel (std::string const &channelName, ChannelRequester::shared_pointer const &channelRequester, short priority, std::string const &address)
virtual void	configure (epics::pvData::PVStructure::shared_pointer configuration)
virtual void	flush ()
virtual void	poll ()
void	attachContext ()
void	addChannel (const CAChannelPtr &channel)
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)

Additional Inherited Members
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
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 47 of file caProviderPvt.h.

Constructor & Destructor Documentation

epics::pvAccess::ca::CAChannelProvider::CAChannelProvider

(

)

Definition at line 35 of file caProvider.cpp.

    : current_context(0)
{
    initialize();
}

epics::pvAccess::ca::CAChannelProvider::CAChannelProvider

(

const std::tr1::shared_ptr< Configuration > &

)

Definition at line 41 of file caProvider.cpp.

    :  current_context(0),
       channelConnectThread(ChannelConnectThread::get()),
       monitorEventThread(MonitorEventThread::get()),
       getDoneThread(GetDoneThread::get()),
       putDoneThread(PutDoneThread::get())
{
    if(DEBUG_LEVEL>0) {
          std::cout<< "CAChannelProvider::CAChannelProvider\n";
    }
    initialize();
}

epics::pvAccess::ca::CAChannelProvider::~CAChannelProvider ( )

virtual

Definition at line 54 of file caProvider.cpp.

{
    if(DEBUG_LEVEL>0) {
         std::cout << "CAChannelProvider::~CAChannelProvider()"
            << " caChannelList.size() " << caChannelList.size()
            << std::endl;
    }
    std::queue<CAChannelPtr> channelQ;
    {
         Lock lock(channelListMutex);
         for(size_t i=0; i< caChannelList.size(); ++i)
         {
             CAChannelPtr caChannel(caChannelList[i].lock());
             if(caChannel) channelQ.push(caChannel);
         }
         caChannelList.clear();
    }
    while(!channelQ.empty()) {
       if(DEBUG_LEVEL>0) {
           std::cout << "~CAChannelProvider() calling disconnectChannel "
                     << channelQ.front()->getChannelName()
                      << std::endl;
       }
       channelQ.front()->disconnectChannel();
       channelQ.pop();
    }
    putDoneThread->stop();
    getDoneThread->stop();
    monitorEventThread->stop();
    channelConnectThread->stop();
    if(DEBUG_LEVEL>0) {
        std::cout << "CAChannelProvider::~CAChannelProvider() calling ca_context_destroy\n";
    }
    ca_context_destroy();
//std::cout << "CAChannelProvider::~CAChannelProvider() returning\n";
}

Member Function Documentation

void epics::pvAccess::ca::CAChannelProvider::addChannel

(

const CAChannelPtr &

channel

)

Definition at line 147 of file caProvider.cpp.

{
    if(DEBUG_LEVEL>0) {
         std::cout << "CAChannelProvider::addChannel "
             << channel->getChannelName()
             << std::endl;
    }
    Lock lock(channelListMutex);
    for(size_t i=0; i< caChannelList.size(); ++i) {
         if(!(caChannelList[i].lock())) {
             caChannelList[i] = channel;
             return;
         }
    }
    caChannelList.push_back(channel);
}

void epics::pvAccess::ca::CAChannelProvider::attachContext

(

)

Definition at line 176 of file caProvider.cpp.

{
    ca_client_context* thread_context = ca_current_context();
    if (thread_context == current_context) return;
    int result = ca_attach_context(current_context);
    if(result==ECA_ISATTACHED) return;
    if (result != ECA_NORMAL) {
        std::string mess("CAChannelProvider::attachContext error  calling ca_attach_context ");
        mess += ca_message(result);
        throw std::runtime_error(mess);
    }
}

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

virtual

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 96 of file caProvider.cpp.

{
    if (channelName.empty())
        throw std::invalid_argument("CAChannelProvider::channelFind empty channel name");

    if (!channelFindRequester)
        throw std::invalid_argument("CAChannelProvider::channelFind null requester");

    Status errorStatus(Status::STATUSTYPE_ERROR, "CAChannelProvider::channelFind not implemented");
    ChannelFind::shared_pointer nullChannelFind;
    EXCEPTION_GUARD(channelFindRequester->channelFindResult(errorStatus, nullChannelFind, false));
    return nullChannelFind;
}

ChannelFind::shared_pointer epics::pvAccess::ca::CAChannelProvider::channelList ( ChannelListRequester::shared_pointer const &  requester )

virtual

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 112 of file caProvider.cpp.

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

    Status errorStatus(Status::STATUSTYPE_ERROR, "CAChannelProvider::channelList not implemented");
    ChannelFind::shared_pointer nullChannelFind;
    PVStringArray::const_svector none;
    EXCEPTION_GUARD(channelListRequester->channelListResult(errorStatus, nullChannelFind, none, false));
    return nullChannelFind;
}

void epics::pvAccess::ca::CAChannelProvider::configure ( epics::pvData::PVStructure::shared_pointer  configuration )

virtual

Definition at line 164 of file caProvider.cpp.

{
}

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

virtual

See longer form

Reimplemented from epics::pvAccess::ChannelProvider.

Definition at line 125 of file caProvider.cpp.

{
    Channel::shared_pointer channel(
        createChannel(channelName, channelRequester, priority, std::string()));
    return channel;
}

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

virtual

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 135 of file caProvider.cpp.

{
    if (!address.empty())
        throw std::invalid_argument("CAChannelProvider::createChannel does not support 'address' parameter");

    return CAChannel::create(shared_from_this(), channelName, priority, channelRequester);
}

void epics::pvAccess::ca::CAChannelProvider::flush ( )

virtual

Definition at line 168 of file caProvider.cpp.

{
}

std::string epics::pvAccess::ca::CAChannelProvider::getProviderName ( )

virtual

Get the provider name.

Returns

The name.

Implements epics::pvAccess::ChannelProvider.

Definition at line 91 of file caProvider.cpp.

{
    return "ca";
}

epics::pvAccess::ca::CAChannelProvider::POINTER_DEFINITIONS

(

CAChannelProvider

)

void epics::pvAccess::ca::CAChannelProvider::poll ( )

virtual

Definition at line 172 of file caProvider.cpp.

{
}

---

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

• modules/pvAccess/src/ca/caProviderPvt.h
• modules/pvAccess/src/ca/caProvider.cpp