BaseMonitor Struct Reference

#include "pvahelper.h"

Inheritance diagram for BaseMonitor:

Collaboration diagram for BaseMonitor:

Classes
struct	no_overflow

Public Types
typedef epics::pvAccess::MonitorRequester	requester_t
typedef epicsGuard< epicsMutex >	guard_t
typedef epicsGuardRelease< epicsMutex >	unguard_t
Public Types inherited from epics::pvAccess::Monitor
typedef MonitorRequester	requester_type

Public Member Functions
	POINTER_DEFINITIONS (BaseMonitor)
shared_pointer	shared_from_this ()
	BaseMonitor (epicsMutex &lock, const requester_t::weak_pointer &requester, const epics::pvData::PVStructure::shared_pointer &pvReq)
virtual	~BaseMonitor ()
const epics::pvData::PVStructurePtr &	getValue ()
void	connect (guard_t &guard, const epics::pvData::PVStructurePtr &value)
bool	post (guard_t &guard, const epics::pvData::BitSet &updated, no_overflow)
	post update if queue not full, if full return false w/o overflow More...
bool	post (guard_t &guard)
	post update of pending changes. eg. call from requestUpdate() More...
bool	post (guard_t &guard, const epics::pvData::BitSet &updated, const epics::pvData::BitSet &overflowed)
	post update with changed and overflowed masks (eg. when updates were lost in some upstream queue) More...
bool	post (guard_t &guard, const epics::pvData::BitSet &updated)
	post update with changed More...
virtual void	onStart ()
virtual void	onStop ()
virtual void	requestUpdate ()
virtual void	destroy ()
virtual void	getStats (Stats &s) const
Public Member Functions inherited from epics::pvAccess::Monitor
	POINTER_DEFINITIONS (Monitor)
virtual	~Monitor ()
virtual void	reportRemoteQueueStatus (epics::pvData::int32 freeElements)
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)

Public Attributes
weak_pointer	weakself
epicsMutex &	lock

Additional Inherited Members
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Helper which implements a Monitor queue. connect()s to a complete copy of a PVStructure. When this struct has changed, post(BitSet) should be called.

Derived class may use onStart(), onStop(), and requestUpdate() to react to subscriber events.

Definition at line 69 of file pvahelper.h.

Member Typedef Documentation

typedef epicsGuard<epicsMutex> BaseMonitor::guard_t

Definition at line 78 of file pvahelper.h.

typedef epics::pvAccess::MonitorRequester BaseMonitor::requester_t

Definition at line 75 of file pvahelper.h.

typedef epicsGuardRelease<epicsMutex> BaseMonitor::unguard_t

Definition at line 79 of file pvahelper.h.

Constructor & Destructor Documentation

BaseMonitor::BaseMonitor ( epicsMutex &  lock, const requester_t::weak_pointer &  requester, const epics::pvData::PVStructure::shared_pointer &  pvReq  )

inline

Definition at line 94 of file pvahelper.h.

        :lock(lock)
        ,requester(requester)
        ,inoverflow(false)
        ,running(false)
        ,nbuffers(2)
    {}

virtual BaseMonitor::~BaseMonitor ( )

inlinevirtual

Definition at line 104 of file pvahelper.h.

{destroy();}

Member Function Documentation

void BaseMonitor::connect ( guard_t &  guard, const epics::pvData::PVStructurePtr &  value  )

inline

Must call before first post(). Sets .complete and calls monitorConnect()

Note

that value will never by accessed except by post() and requestUpdate()

Definition at line 110 of file pvahelper.h.

    {
        guard.assertIdenticalMutex(lock);
        epics::pvData::StructureConstPtr dtype(value->getStructure());
        epics::pvData::PVDataCreatePtr create(epics::pvData::getPVDataCreate());
        BaseMonitor::shared_pointer self(shared_from_this());
        requester_t::shared_pointer req(requester.lock());

        assert(!complete); // can't call twice

        complete = value;
        empty.resize(nbuffers);
        for(size_t i=0; i<empty.size(); i++) {
            empty[i].reset(new epics::pvAccess::MonitorElement(create->createPVStructure(dtype)));
        }

        if(req) {
            unguard_t U(guard);
            epics::pvData::Status sts;
            req->monitorConnect(sts, self, dtype);
        }
    }

virtual void BaseMonitor::destroy ( )

inlinevirtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Reimplemented in PDBGroupMonitor, and PDBSingleMonitor.

Definition at line 273 of file pvahelper.h.

    {
        stop();
    }

virtual void BaseMonitor::getStats ( Stats &  s ) const

inlinevirtual

Reimplemented from epics::pvAccess::Monitor.

Definition at line 341 of file pvahelper.h.

    {
        guard_t G(lock);
        s.nempty = empty.size();
        s.nfilled = inuse.size();
        s.noutstanding = nbuffers - s.nempty - s.nfilled;
    }

const epics::pvData::PVStructurePtr& BaseMonitor::getValue ( )

inline

Definition at line 106 of file pvahelper.h.

{ return complete; }

virtual void BaseMonitor::onStart ( )

inlinevirtual

Reimplemented in PDBGroupMonitor, and PDBSingleMonitor.

Definition at line 267 of file pvahelper.h.

{}

virtual void BaseMonitor::onStop ( )

inlinevirtual

Reimplemented in PDBGroupMonitor, and PDBSingleMonitor.

Definition at line 268 of file pvahelper.h.

{}

BaseMonitor::POINTER_DEFINITIONS

(

BaseMonitor

)

bool BaseMonitor::post ( guard_t &  guard, const epics::pvData::BitSet &  updated, no_overflow    )

inline

post update if queue not full, if full return false w/o overflow

Definition at line 136 of file pvahelper.h.

    {
        guard.assertIdenticalMutex(lock);
        requester_t::shared_pointer req;

        if(!complete || !running) return false;

        changed |= updated;

        if(empty.empty()) return false;

        if(p_postone())
            req = requester.lock();
        inoverflow = false;

        if(req) {
            unguard_t U(guard);
            req->monitorEvent(shared_from_this());
        }
        return true;
    }

bool BaseMonitor::post ( guard_t &  guard )

inline

post update of pending changes. eg. call from requestUpdate()

Definition at line 159 of file pvahelper.h.

    {
        guard.assertIdenticalMutex(lock);
        bool oflow;
        requester_t::shared_pointer req;

        if(!complete || !running) return false;

        if(empty.empty()) {
            oflow = inoverflow = true;

        } else {

            if(p_postone())
                req = requester.lock();
            oflow = inoverflow = false;
        }

        if(req) {
            unguard_t U(guard);
            req->monitorEvent(shared_from_this());
        }
        return !oflow;
    }

bool BaseMonitor::post ( guard_t &  guard, const epics::pvData::BitSet &  updated, const epics::pvData::BitSet &  overflowed  )

inline

post update with changed and overflowed masks (eg. when updates were lost in some upstream queue)

Definition at line 185 of file pvahelper.h.

    {
        guard.assertIdenticalMutex(lock);
        bool oflow;
        requester_t::shared_pointer req;

        if(!complete || !running) return false;

        if(empty.empty()) {
            oflow = inoverflow = true;
            overflow |= overflowed;
            overflow.or_and(updated, changed);
            changed |= updated;

        } else {

            changed |= updated;
            if(p_postone())
                req = requester.lock();
            oflow = inoverflow = false;
        }

        if(req) {
            unguard_t U(guard);
            req->monitorEvent(shared_from_this());
        }
        return !oflow;
    }

bool BaseMonitor::post ( guard_t &  guard, const epics::pvData::BitSet &  updated  )

inline

post update with changed

Definition at line 217 of file pvahelper.h.

                                                                {
        bool oflow;
        requester_t::shared_pointer req;

        if(!complete || !running) return false;

        if(empty.empty()) {
            oflow = inoverflow = true;
            overflow.or_and(updated, changed);
            changed |= updated;

        } else {

            changed |= updated;
            if(p_postone())
                req = requester.lock();
            oflow = inoverflow = false;
        }

        if(req) {
            unguard_t U(guard);
            req->monitorEvent(shared_from_this());
        }
        return !oflow;
    }

virtual void BaseMonitor::requestUpdate ( )

inlinevirtual

called when within release() when the opportunity exists to end the overflow condition May do nothing, or lock and call post()

Reimplemented in PDBGroupMonitor, and PDBSingleMonitor.

Definition at line 271 of file pvahelper.h.

{guard_t G(lock); post(G);}

shared_pointer BaseMonitor::shared_from_this ( )

inline

Definition at line 73 of file pvahelper.h.

{ return shared_pointer(weakself); }

Member Data Documentation

epicsMutex& BaseMonitor::lock

Definition at line 77 of file pvahelper.h.

weak_pointer BaseMonitor::weakself

Definition at line 72 of file pvahelper.h.

---

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

• modules/pva2pva/common/pvahelper.h