epics::pvAccess::MonitorRequester Class Reference

Callback implemented by monitor clients. More...

#include <client/pv/pvAccess.h>

Inheritance diagram for epics::pvAccess::MonitorRequester:

Collaboration diagram for epics::pvAccess::MonitorRequester:

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

Public Member Functions
virtual void	monitorConnect (epics::pvData::Status const &status, MonitorPtr const &monitor, epics::pvData::StructureConstPtr const &structure)=0
	Underlying Channel is connected and operation setup is complete.
virtual void	monitorEvent (MonitorPtr const &monitor)=0
	Monitor queue is not empty.
virtual void	unlisten (MonitorPtr const &monitor)=0
	No more subscription update will be sent.
virtual void	channelDisconnect (bool destroy)
	Notification when underlying Channel becomes DISCONNECTED or DESTORYED.
virtual std::string	getRequesterName ()=0
	The requester must have a name.
virtual void	message (std::string const &message, MessageType messageType=errorMessage)
	Push notification.

Static Public Attributes
static size_t	num_instances

Detailed Description

Callback implemented by monitor clients.

Requester for ChannelMonitor.

Author

mrk

Definition at line 249 of file pvAccess.h.

Member Typedef Documentation

const_shared_pointer

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

Definition at line 251 of file pvAccess.h.

const_weak_pointer

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

Definition at line 251 of file pvAccess.h.

operation_type

typedef Monitor epics::pvAccess::MonitorRequester::operation_type

Definition at line 252 of file pvAccess.h.

shared_pointer

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

Definition at line 251 of file pvAccess.h.

weak_pointer

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

Definition at line 251 of file pvAccess.h.

Constructor & Destructor Documentation

~MonitorRequester()

virtual epics::pvAccess::MonitorRequester::~MonitorRequester ( )

inlinevirtual

Definition at line 254 of file pvAccess.h.

Member Function Documentation

channelDisconnect()

virtual void epics::pvAccess::ChannelBaseRequester::channelDisconnect ( bool destroy )

inlinevirtualinherited

Notification when underlying Channel becomes DISCONNECTED or DESTORYED.

(re)connection is notified through a sub-class *Connect() method.

Any in-progress get()/put()/request()/start() is implicitly cancel()'d or stop()'d before this method is called.

Ownership of any PVStructures passed to completion callbacks (eg. ChannelGetRequester::getDone() ) is returned the operation

Parameters

destroy

true for final disconnect.

Definition at line 198 of file pvAccess.h.

getRequesterName()

virtual std::string epics::pvAccess::Requester::getRequesterName ( )

pure virtualinherited

The requester must have a name.

Returns

The requester's name.

Implemented in epics::pvAccess::Channel, and epics::pvAccess::DefaultChannelRequester.

message()

virtual void epics::pvAccess::Requester::message ( std::string const & message, MessageType messageType = errorMessage )

virtualinherited

Push notification.

Reimplemented in epics::pvAccess::Channel.

monitorConnect()

virtual void epics::pvAccess::MonitorRequester::monitorConnect ( epics::pvData::Status const & status, MonitorPtr const & monitor, epics::pvData::StructureConstPtr const & structure )

pure virtual

Underlying Channel is connected and operation setup is complete.

Call start() to begin subscription updates.

Parameters

status	Completion status.
monitor	The monitor
structure	The structure defining the data.

monitorEvent()

virtual void epics::pvAccess::MonitorRequester::monitorEvent ( MonitorPtr const & monitor )

pure virtual

Monitor queue is not empty.

The requester must call Monitor.poll to get data.

Parameters

monitor

The monitor.

unlisten()

virtual void epics::pvAccess::MonitorRequester::unlisten ( MonitorPtr const & monitor )

pure virtual

No more subscription update will be sent.

Parameters

monitor

The monitor.

Member Data Documentation

num_instances

size_t epics::pvAccess::ChannelBaseRequester::num_instances

staticinherited

Definition at line 181 of file pvAccess.h.

---

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

• client/pv/pvAccess.h