epics::pvAccess::Monitor Class Reference

Access to Monitor subscription and queue. More...

#include <client/pv/monitor.h>

Inheritance diagram for epics::pvAccess::Monitor:

Collaboration diagram for epics::pvAccess::Monitor:

Public Types
typedef std::tr1::shared_ptr< Monitor >	shared_pointer
typedef std::tr1::shared_ptr< const Monitor >	const_shared_pointer
typedef std::tr1::weak_ptr< Monitor >	weak_pointer
typedef std::tr1::weak_ptr< const Monitor >	const_weak_pointer
typedef MonitorRequester	requester_type

Public Member Functions
virtual epics::pvData::Status	start ()=0
	Start monitoring.
virtual epics::pvData::Status	stop ()=0
	Stop Monitoring.
virtual MonitorElementPtr	poll ()=0
	If monitor has occurred return data.
virtual void	release (MonitorElementPtr const &monitorElement)=0
	Release a MonitorElement that was returned by poll.
virtual void	getStats (Stats &s) const
virtual void	reportRemoteQueueStatus (epics::pvData::int32 freeElements)
	Report remote queue status.
virtual void	destroy ()
	Destroy this instance.

Detailed Description

Access to Monitor subscription and queue.

Downstream interface to access a monitor queue (via poll() and release() )

Definition at line 69 of file monitor.h.

Member Typedef Documentation

const_shared_pointer

typedef std::tr1::shared_ptr<const Monitor> epics::pvAccess::Monitor::const_shared_pointer

Definition at line 71 of file monitor.h.

const_weak_pointer

typedef std::tr1::weak_ptr<const Monitor> epics::pvAccess::Monitor::const_weak_pointer

Definition at line 71 of file monitor.h.

requester_type

typedef MonitorRequester epics::pvAccess::Monitor::requester_type

Definition at line 72 of file monitor.h.

shared_pointer

typedef std::tr1::shared_ptr<Monitor> epics::pvAccess::Monitor::shared_pointer

Definition at line 71 of file monitor.h.

weak_pointer

typedef std::tr1::weak_ptr<Monitor> epics::pvAccess::Monitor::weak_pointer

Definition at line 71 of file monitor.h.

Constructor & Destructor Documentation

~Monitor()

virtual epics::pvAccess::Monitor::~Monitor ( )

inlinevirtual

Definition at line 74 of file monitor.h.

Member Function Documentation

destroy()

virtual void epics::pvAccess::Destroyable::destroy ( )

inlinevirtualinherited

Destroy this instance.

Reimplemented in epics::pvAccess::MonitorFIFO.

Definition at line 30 of file destroyable.h.

getStats()

virtual void epics::pvAccess::Monitor::getStats ( Stats & s ) const

inlinevirtual

Definition at line 106 of file monitor.h.

poll()

virtual MonitorElementPtr epics::pvAccess::Monitor::poll ( )

pure 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()

Implemented in epics::pvAccess::MonitorFIFO.

release()

virtual void epics::pvAccess::Monitor::release ( MonitorElementPtr const & monitorElement )

pure 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

Implemented in epics::pvAccess::MonitorFIFO.

reportRemoteQueueStatus()

virtual void epics::pvAccess::Monitor::reportRemoteQueueStatus ( epics::pvData::int32 freeElements )

inlinevirtual

Report remote queue status.

Parameters

freeElements

number of free elements.

Reimplemented in epics::pvAccess::MonitorFIFO.

Definition at line 114 of file monitor.h.

start()

virtual epics::pvData::Status epics::pvAccess::Monitor::start ( )

pure virtual

Start monitoring.

Returns

completion status.

Implemented in epics::pvAccess::MonitorFIFO.

stop()

virtual epics::pvData::Status epics::pvAccess::Monitor::stop ( )

pure virtual

Stop Monitoring.

Returns

completion status.

Implemented in epics::pvAccess::MonitorFIFO.

---

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

• client/pv/monitor.h