pvac::Monitor Struct Reference

Handle for monitor subscription. More...

#include "client.h"

Inheritance diagram for pvac::Monitor:

Collaboration diagram for pvac::Monitor:

Public Member Functions
	Monitor ()
	Monitor (const std::tr1::shared_ptr< Impl > &)
	~Monitor ()
std::string	name () const
	Channel name. More...
void	cancel ()
	Immediate cancellation. More...
bool	poll ()
bool	complete () const
bool	valid () const
	operator bool_type () const
void	reset ()

Public Attributes
epics::pvData::PVStructure::const_shared_pointer	root
epics::pvData::BitSet	changed
epics::pvData::BitSet	overrun

Friends
struct	MonitorSync
epicsShareFunc::std::ostream &	operator<< (::std::ostream &strm, const Monitor &op)

Detailed Description

Handle for monitor subscription.

Definition at line 117 of file client.h.

Constructor & Destructor Documentation

pvac::Monitor::Monitor ( )

inline

Definition at line 120 of file client.h.

{}

pvac::Monitor::Monitor

(

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

impl

)

Definition at line 185 of file clientMonitor.cpp.

    :impl(impl)
{}

pvac::Monitor::~Monitor

(

)

Definition at line 189 of file clientMonitor.cpp.

{}

Member Function Documentation

void pvac::Monitor::cancel

(

)

Immediate cancellation.

Does not wait for remote confirmation.

Since

Up to 7.0.0 also cleared root, changed, and overrun. After 7.0.0, these data members are left unchanged.

Definition at line 197 of file clientMonitor.cpp.

{
    if(impl) impl->cancel();
}

bool pvac::Monitor::complete

(

)

const

true if all events received. Check after poll()==false

Definition at line 233 of file clientMonitor.cpp.

{
    if(!impl) return true;
    Guard G(impl->mutex);
    return impl->done && impl->seenEmpty;
}

std::string pvac::Monitor::name

(

)

const

Channel name.

Definition at line 192 of file clientMonitor.cpp.

{
    return impl ? impl->chan->getChannelName() : "<NULL>";
}

pvac::Monitor::operator bool_type ( ) const

inline

Definition at line 172 of file client.h.

{ return valid() ? &Monitor::valid : 0; }

bool pvac::Monitor::poll

(

)

updates root, changed, overrun

Returns

true if a new update was extracted from the queue.

Note

This method does not block.

MonitorEvent::Data will not be repeated until poll()==false.

Postcondition

root!=NULL (after version 6.0.0)

root!=NULL iff poll()==true (In version 6.0.0)

Definition at line 202 of file clientMonitor.cpp.

{
    if(!impl) return false;
    Guard G(impl->mutex);

    if(!impl->done && impl->op && impl->started && impl->last.next()) {
        const epics::pvData::PVStructurePtr& ptr = impl->last->pvStructurePtr;
        changed = *impl->last->changedBitSet;
        overrun = *impl->last->overrunBitSet;

        /* copy the exposed PVStructure for two reasons.
         * 1. Prevent accidental use of shared container after release()
         * 2. Allows caller to cache results of getSubField() until root.get() changes.
         */
        if(!root || (void*)root->getField().get()!=(void*)ptr->getField().get()) {
            // initial connection, or new type
            root = pvd::getPVDataCreate()->createPVStructure(ptr); // also calls copyUnchecked()
        } else {
            // same type
            const_cast<pvd::PVStructure&>(*root).copyUnchecked(*ptr, changed);
        }

        impl->seenEmpty = false;
    } else {
        changed.clear();
        overrun.clear();
        impl->seenEmpty = true;
    }
    return !impl->seenEmpty;
}

void pvac::Monitor::reset ( )

inline

Definition at line 175 of file client.h.

{ impl.reset(); }

bool pvac::Monitor::valid ( void  ) const

inline

Definition at line 164 of file client.h.

{ return !!impl; }

Friends And Related Function Documentation

friend struct MonitorSync

friend

Definition at line 180 of file client.h.

epicsShareFunc ::std::ostream& operator<< ( ::std::ostream &  strm, const Monitor &  op  )

friend

Definition at line 260 of file clientMonitor.cpp.

{
    if(op.impl) {
        strm << "Monitor("
                "\"" << op.impl->chan->getChannelName() <<"\", "
                "\"" << op.impl->chan->getProvider()->getProviderName() <<"\", "
                "connected="<<(op.impl->chan->isConnected()?"true":"false")
             <<"\")";
    } else {
        strm << "Monitor()";
    }
    return strm;
}

Member Data Documentation

epics::pvData::BitSet pvac::Monitor::changed

Definition at line 161 of file client.h.

epics::pvData::BitSet pvac::Monitor::overrun

Definition at line 161 of file client.h.

epics::pvData::PVStructure::const_shared_pointer pvac::Monitor::root

Monitor update data.

After version 6.0.0

Initially NULL, becomes !NULL the first time poll()==true. The PVStructure pointed to be root will presist until Monitor reconnect w/ type change. This can be detected by comparing root.get(). references to root may be cached subject to this test.

In version 6.0.0

NULL except after poll()==true. poll()==false sets root=NULL. references to root should not be stored between calls to poll().

Definition at line 160 of file client.h.

---

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

• modules/pvAccess/src/client/pva/client.h
• modules/pvAccess/src/client/clientMonitor.cpp