MonitorUser Struct Reference

#include "chancache.h"

Inheritance diagram for MonitorUser:

Collaboration diagram for MonitorUser:

Public Member Functions
	POINTER_DEFINITIONS (MonitorUser)
epicsMutex &	mutex () const
	MonitorUser (const MonitorCacheEntry::shared_pointer &)
virtual	~MonitorUser ()
virtual void	destroy ()
virtual epics::pvData::Status	start ()
virtual epics::pvData::Status	stop ()
virtual epics::pvData::MonitorElementPtr	poll ()
virtual void	release (epics::pvData::MonitorElementPtr const &monitorElement)
virtual std::string	getRequesterName ()
Public Member Functions inherited from epics::pvAccess::Monitor
	POINTER_DEFINITIONS (Monitor)
virtual	~Monitor ()
virtual void	release (MonitorElementPtr const &monitorElement)=0
virtual void	getStats (Stats &s) const
virtual void	reportRemoteQueueStatus (epics::pvData::int32 freeElements)
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)

Public Attributes
weak_pointer	weakref
MonitorCacheEntry::shared_pointer	entry
epics::pvData::MonitorRequester::weak_pointer	req
std::tr1::weak_ptr< GWChannel >	srvchan
bool	initial
bool	running
bool	inoverflow
size_t	nwakeups
size_t	nevents
size_t	ndropped
std::deque< epics::pvData::MonitorElementPtr >	filled
std::deque< epics::pvData::MonitorElementPtr >	empty
std::set< epics::pvData::MonitorElementPtr >	inuse
epics::pvData::MonitorElementPtr	overflowElement

Static Public Attributes
static size_t	num_instances

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 67 of file chancache.h.

Constructor & Destructor Documentation

MonitorUser::MonitorUser

(

const MonitorCacheEntry::shared_pointer &

e

)

Definition at line 244 of file moncache.cpp.

    :entry(e)
    ,initial(true)
    ,running(false)
    ,inoverflow(false)
    ,nevents(0)
    ,ndropped(0)
{
    epicsAtomicIncrSizeT(&num_instances);
}

MonitorUser::~MonitorUser ( )

virtual

Definition at line 255 of file moncache.cpp.

{
    epicsAtomicDecrSizeT(&num_instances);
}

Member Function Documentation

void MonitorUser::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 262 of file moncache.cpp.

{
    {
        Guard G(mutex());
        running = false;
    }
}

std::string MonitorUser::getRequesterName ( )

virtual

Definition at line 378 of file moncache.cpp.

{
    return "MonitorCacheEntry";
}

epicsMutex& MonitorUser::mutex ( ) const

inline

Definition at line 73 of file chancache.h.

{ return entry->mutex(); }

MonitorUser::POINTER_DEFINITIONS

(

MonitorUser

)

pva::MonitorElementPtr MonitorUser::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 332 of file moncache.cpp.

{
    Guard G(mutex());
    pva::MonitorElementPtr ret;
    if(!filled.empty()) {
        ret = filled.front();
        inuse.insert(ret); // track which ones are out for client use
        filled.pop_front();
        //TODO: track lost buffers w/ wrapped shared_ptr?
    }
    return ret;
}

void MonitorUser::release ( epics::pvData::MonitorElementPtr const &  monitorElement )

virtual

Definition at line 346 of file moncache.cpp.

{
    Guard G(mutex());
    //TODO: ifdef DEBUG? (only track inuse when debugging?)
    std::set<epics::pvData::MonitorElementPtr>::iterator it = inuse.find(monitorElement);
    if(it!=inuse.end()) {
        inuse.erase(it);

        if(inoverflow) { // leaving overflow condition

            // to avoid copy, enqueue the current overflowElement
            // and replace it with the element being release()d

            filled.push_back(overflowElement);
            overflowElement = monitorElement;
            overflowElement->changedBitSet->clear();
            overflowElement->overrunBitSet->clear();

            inoverflow = false;
        } else {
            // push_back empty element
            empty.push_back(monitorElement);
        }
    } else {
        // oh no, we've been given an element which we didn't give to downstream
        //TODO: check empty and filled lists to see if this is one of ours, of from somewhere else
        throw std::invalid_argument("Can't release MonitorElement not in use");
    }
    // TODO: pipeline window update?
}

pvd::Status MonitorUser::start ( )

virtual

Start monitoring.

Returns

completion status.

Implements epics::pvAccess::Monitor.

Definition at line 271 of file moncache.cpp.

{
    pvd::MonitorRequester::shared_pointer req(this->req.lock());
    if(!req)
        return pvd::Status(pvd::Status::STATUSTYPE_FATAL, "already dead");

    bool doEvt = false;
    {
        Guard G(entry->mutex()); // MCE and MU have share a lock

        if(!entry->startresult.isSuccess())
            return entry->startresult;

        pvd::PVStructurePtr lval;
        if(entry->havedata)
            lval = entry->lastelem->pvStructurePtr;
        pvd::StructureConstPtr typedesc(entry->typedesc);

        if(initial) {
            initial = false;

            empty.resize(entry->bufferSize);
            pvd::PVDataCreatePtr fact(pvd::getPVDataCreate());
            for(unsigned i=0; i<empty.size(); i++) {
                empty[i].reset(new pvd::MonitorElement(fact->createPVStructure(typedesc)));
            }

            // extra element to accumulate updates during overflow
            overflowElement.reset(new pvd::MonitorElement(fact->createPVStructure(typedesc)));
        }

        doEvt = filled.empty();

        if(lval && !empty.empty()) {
            //already running, notify of initial element

            const pva::MonitorElementPtr& elem(empty.front());
            elem->pvStructurePtr->copy(*lval);
            elem->changedBitSet->set(0); // indicate all changed
            elem->overrunBitSet->clear();
            filled.push_back(elem);
            empty.pop_front();
        }

        doEvt &= !filled.empty();
        running = true;
    }
    if(doEvt)
        req->monitorEvent(shared_pointer(weakref)); // TODO: worker thread?
    return pvd::Status();
}

pvd::Status MonitorUser::stop ( )

virtual

Stop Monitoring.

Returns

completion status.

Implements epics::pvAccess::Monitor.

Definition at line 324 of file moncache.cpp.

{
    Guard G(mutex());
    running = false;
    return pvd::Status::Ok;
}

Member Data Documentation

std::deque<epics::pvData::MonitorElementPtr> MonitorUser::empty

Definition at line 87 of file chancache.h.

MonitorCacheEntry::shared_pointer MonitorUser::entry

Definition at line 75 of file chancache.h.

std::deque<epics::pvData::MonitorElementPtr> MonitorUser::filled

Definition at line 87 of file chancache.h.

bool MonitorUser::initial

Definition at line 80 of file chancache.h.

bool MonitorUser::inoverflow

Definition at line 82 of file chancache.h.

std::set<epics::pvData::MonitorElementPtr> MonitorUser::inuse

Definition at line 88 of file chancache.h.

size_t MonitorUser::ndropped

Definition at line 85 of file chancache.h.

size_t MonitorUser::nevents

Definition at line 84 of file chancache.h.

size_t MonitorUser::num_instances

static

Definition at line 70 of file chancache.h.

size_t MonitorUser::nwakeups

Definition at line 83 of file chancache.h.

epics::pvData::MonitorElementPtr MonitorUser::overflowElement

Definition at line 90 of file chancache.h.

epics::pvData::MonitorRequester::weak_pointer MonitorUser::req

Definition at line 76 of file chancache.h.

bool MonitorUser::running

Definition at line 81 of file chancache.h.

std::tr1::weak_ptr<GWChannel> MonitorUser::srvchan

Definition at line 77 of file chancache.h.

weak_pointer MonitorUser::weakref

Definition at line 71 of file chancache.h.

---

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

• modules/pva2pva/p2pApp/chancache.h
• modules/pva2pva/p2pApp/moncache.cpp