epics::pvAccess::ca::CAChannelMonitor Class Reference

#include "caChannel.h"

Inheritance diagram for epics::pvAccess::ca::CAChannelMonitor:

Collaboration diagram for epics::pvAccess::ca::CAChannelMonitor:

Public Member Functions
	POINTER_DEFINITIONS (CAChannelMonitor)
virtual	~CAChannelMonitor ()
void	subscriptionEvent (struct event_handler_args &args)
virtual epics::pvData::Status	start ()
virtual epics::pvData::Status	stop ()
virtual MonitorElementPtr	poll ()
virtual void	release (MonitorElementPtr const &monitorElement)
virtual void	cancel ()
virtual std::string	getRequesterName ()
void	activate ()
void	notifyClient ()
Public Member Functions inherited from epics::pvAccess::Monitor
	POINTER_DEFINITIONS (Monitor)
virtual	~Monitor ()
virtual void	getStats (Stats &s) const
virtual void	reportRemoteQueueStatus (epics::pvData::int32 freeElements)
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)

Static Public Member Functions
static CAChannelMonitor::shared_pointer	create (CAChannel::shared_pointer const &channel, MonitorRequester::shared_pointer const &monitorRequester, epics::pvData::PVStructurePtr const &pvRequest)

Additional Inherited Members
Public Types inherited from epics::pvAccess::Monitor
typedef MonitorRequester	requester_type
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 235 of file caChannel.h.

Constructor & Destructor Documentation

epics::pvAccess::ca::CAChannelMonitor::~CAChannelMonitor ( )

virtual

Definition at line 840 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        std::cout << "CAChannelMonitor::~CAChannelMonitor() "
            << channel->getChannelName()
            << " isStarted " << (isStarted ? "true" : "false")
            << endl;
    }
    stop();
}

Member Function Documentation

void epics::pvAccess::ca::CAChannelMonitor::activate

(

)

Definition at line 851 of file caChannel.cpp.

{
    MonitorRequester::shared_pointer requester(monitorRequester.lock());
    if(!requester) return;
    if(DEBUG_LEVEL>0) {
        std::cout << "CAChannelMonitor::activate " << channel->getChannelName() << endl;
    }
    dbdToPv = DbdToPv::create(channel,pvRequest,monitorIO);
    dbdToPv->getChoices(channel);
    pvStructure = dbdToPv->createPVStructure();
    activeElement = MonitorElementPtr(new MonitorElement(pvStructure));
    int32 queueSize = 2;
    PVStructurePtr pvOptions = pvRequest->getSubField<PVStructure>("record._options");
    if (pvOptions) {
        PVStringPtr pvString = pvOptions->getSubField<PVString>("queueSize");
        if (pvString) {
            int size=0;
            std::stringstream ss;
            ss << pvString->get();
            ss >> size;
            if (size > 1) queueSize = size;
        }
        pvString = pvOptions->getSubField<PVString>("DBE");
        if(pvString) {
            std::string value(pvString->get());
            eventMask = 0;
            if(value.find("VALUE")!=std::string::npos) eventMask|=DBE_VALUE;
            if(value.find("ARCHIVE")!=std::string::npos) eventMask|=DBE_ARCHIVE;
            if(value.find("ALARM")!=std::string::npos) eventMask|=DBE_ALARM;
            if(value.find("PROPERTY")!=std::string::npos) eventMask|=DBE_PROPERTY;
        }
    }
    notifyMonitorRequester = NotifyMonitorRequesterPtr(new NotifyMonitorRequester());
    notifyMonitorRequester->setChannelMonitor(shared_from_this());
    monitorQueue = CACMonitorQueuePtr(new CACMonitorQueue(queueSize));
    EXCEPTION_GUARD(requester->monitorConnect(Status::Ok, shared_from_this(),
                    pvStructure->getStructure()));
}

void epics::pvAccess::ca::CAChannelMonitor::cancel ( )

virtual

Definition at line 1010 of file caChannel.cpp.

{
    // noop
}

CAChannelMonitorPtr epics::pvAccess::ca::CAChannelMonitor::create ( CAChannel::shared_pointer const &  channel, MonitorRequester::shared_pointer const &  monitorRequester, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Definition at line 815 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        cout << "CAChannelMonitor::create " << channel->getChannelName() << endl;
    }
    return CAChannelMonitorPtr(new CAChannelMonitor(channel, monitorRequester, pvRequest));
}

std::string epics::pvAccess::ca::CAChannelMonitor::getRequesterName ( )

virtual

Definition at line 890 of file caChannel.cpp.

{ return "CAChannelMonitor";}

void epics::pvAccess::ca::CAChannelMonitor::notifyClient

(

)

Definition at line 925 of file caChannel.cpp.

{
    {
         Lock lock(mutex);
         if(!isStarted) return;
    }
    MonitorRequester::shared_pointer requester(monitorRequester.lock());
    if(!requester) return;
    requester->monitorEvent(shared_from_this());
}

epics::pvAccess::ca::CAChannelMonitor::POINTER_DEFINITIONS

(

CAChannelMonitor

)

MonitorElementPtr epics::pvAccess::ca::CAChannelMonitor::poll ( )

virtual

If monitor has occurred return data.

Returns

monitorElement for modified data. Must call get to determine if data is available.

May recursively call MonitorRequester::unlisten()

Implements epics::pvAccess::Monitor.

Definition at line 987 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>1) {
        std::cout << "CAChannelMonitor::poll " << channel->getChannelName() << endl;
    }
    {
         Lock lock(mutex);
         if(!isStarted) return MonitorElementPtr();
    }
    return monitorQueue->poll();
}

void epics::pvAccess::ca::CAChannelMonitor::release ( MonitorElementPtr const &  monitorElement )

virtual

Release a MonitorElement that was returned by poll. A poll() must be called after the release() to check the presence of any modified data.

Parameters

monitorElement

Implements epics::pvAccess::Monitor.

Definition at line 1000 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>1) {
        std::cout << "CAChannelMonitor::release " << channel->getChannelName() << endl;
    }
    monitorQueue->release(monitorElement);
}

Status epics::pvAccess::ca::CAChannelMonitor::start ( )

virtual

Start monitoring.

Returns

completion status.

Implements epics::pvAccess::Monitor.

Definition at line 936 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        std::cout << "CAChannelMonitor::start " << channel->getChannelName() << endl;
    }
    Status status = Status::Ok;
    {
        Lock lock(mutex);
        if(isStarted) {
            status = Status(Status::STATUSTYPE_WARNING,"already started");
            return status;
        }
        isStarted = true;
        monitorQueue->start();
    }
    channel->attachContext();
    int result = ca_create_subscription(dbdToPv->getRequestType(),
         0,
         channel->getChannelID(), eventMask,
         ca_subscription_handler, this,
         &pevid);
    if (result == ECA_NORMAL)
    {
        result = ca_flush_io();
    }
    if (result == ECA_NORMAL) return status;
    isStarted = false;
    string message(ca_message(result));
    return Status(Status::STATUSTYPE_ERROR,message);
}

Status epics::pvAccess::ca::CAChannelMonitor::stop ( )

virtual

Stop Monitoring.

Returns

completion status.

Implements epics::pvAccess::Monitor.

Definition at line 967 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>0) {
        std::cout << "CAChannelMonitor::stop "
            << channel->getChannelName()
            << " isStarted " << (isStarted ? "true" : "false")
            << endl;
    }
    {
         Lock lock(mutex);
         if(!isStarted) return Status(Status::STATUSTYPE_WARNING,"already stopped");
         isStarted = false;
    }
    monitorQueue->stop();
    int result = ca_clear_subscription(pevid);
    if(result==ECA_NORMAL) return Status::Ok;
    return Status(Status::STATUSTYPE_ERROR,string(ca_message(result)));
}

void epics::pvAccess::ca::CAChannelMonitor::subscriptionEvent

(

struct event_handler_args &

args

)

Definition at line 892 of file caChannel.cpp.

{
    if(DEBUG_LEVEL>1) {
        std::cout << "CAChannelMonitor::subscriptionEvent "
             << channel->getChannelName() << endl;
    }
    {
       Lock lock(mutex);
       if(!isStarted) return;
    }
    MonitorRequester::shared_pointer requester(monitorRequester.lock());
    if(!requester) return;
    Status status = dbdToPv->getFromDBD(pvStructure,activeElement->changedBitSet,args);
    if(status.isOK())
    {
        if(monitorQueue->event(pvStructure,activeElement)) {
             activeElement->changedBitSet->clear();
             activeElement->overrunBitSet->clear();
        } else {
            *(activeElement->overrunBitSet) |= *(activeElement->changedBitSet);
        }
        monitorEventThread->event(notifyMonitorRequester);
    }
    else
    {
        string mess("CAChannelMonitor::subscriptionEvent ");
        mess += channel->getChannelName();
        mess += ca_message(args.status);
        throw  std::runtime_error(mess);
    }
}

---

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

• modules/pvAccess/src/ca/caChannel.h
• modules/pvAccess/src/ca/caChannel.cpp