An easy to use alternative to Monitor. More...

#include <pv/pvaClient.h>

Inheritance diagram for epics::pvaClient::PvaClientMonitor:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientMonitor)

	~PvaClientMonitor ()
	Destructor.

void	connect ()
	Call issueConnect and then waitConnect.

void	issueConnect ()
	Issue the channelMonitor connection to the channel.

epics::pvData::Status	waitConnect ()
	Wait until the channelMonitor connection to the channel is complete.

void	setRequester (PvaClientMonitorRequesterPtr const &pvaClientMonitorRequester)
	Set a user callback.

void	start ()
	Start monitoring.

void	start (const std::string &request)
	Start or restart the monitor with a new request.

void	stop ()
	Stop monitoring.

bool	poll ()
	Poll for a monitor event.

bool	waitEvent (double secondsToWait=0.0)
	Wait for a monitor event.

void	releaseEvent ()
	Release the monitorElement returned by poll.

PvaClientChannelPtr	getPvaClientChannel ()
	Get the PvaClientChannel;.

PvaClientMonitorDataPtr	getData ()
	The data in which monitor events are placed.

void	channelStateChange (PvaClientChannelPtr const &channel, bool isConnected)
	A channel connection state change has occurred.

void	event (PvaClientMonitorPtr const &monitor)
	A monitor event has occurred.

	POINTER_DEFINITIONS (PvaClientChannelStateChangeRequester)

	POINTER_DEFINITIONS (PvaClientMonitorRequester)

virtual void	monitorConnect (epics::pvData::Status const &status, PvaClientMonitorPtr const &monitor, epics::pvData::StructureConstPtr const &structure)
	The server has returned a message that the monitor is connected.

virtual void	unlisten ()
	The data source is no longer available.

Static Public Member Functions
static PvaClientMonitorPtr	create (PvaClientPtr const &pvaClient, PvaClientChannelPtr const &pvaClientChannel, epics::pvData::PVStructurePtr const &pvRequest)
	Create a PvaClientMonitor.

static PvaClientMonitorPtr	create (PvaClientPtr const &pvaClient, std::string const &channelName, std::string const &providerName, std::string const &request, PvaClientChannelStateChangeRequesterPtr const &stateChangeRequester=PvaClientChannelStateChangeRequesterPtr(), PvaClientMonitorRequesterPtr const &monitorRequester=PvaClientMonitorRequesterPtr()) EPICS_DEPRECATED
	Create a PvaClientMonitor.

Friends
class	MonitorRequesterImpl

Detailed Description

An easy to use alternative to Monitor.

Definition at line 1512 of file pvaClient.h.

Constructor & Destructor Documentation

◆ ~PvaClientMonitor()

epics::pvaClient::PvaClientMonitor::~PvaClientMonitor ( )

Destructor.

Definition at line 139 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

Member Function Documentation

◆ channelStateChange()

void epics::pvaClient::PvaClientMonitor::channelStateChange	(	PvaClientChannelPtr const &	channel,
		bool	isConnected )

virtual

A channel connection state change has occurred.

Warning A call to a method that blocks should not be made by this method.

Parameters

channel	The channel.
isConnected	The new connection status.

Implements epics::pvaClient::PvaClientChannelStateChangeRequester.

Definition at line 151 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ connect()

void epics::pvaClient::PvaClientMonitor::connect ( )

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Definition at line 299 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug(), issueConnect(), and waitConnect().

Referenced by start(), and start().

◆ create() [1/2]

static PvaClientMonitorPtr epics::pvaClient::PvaClientMonitor::create	(	PvaClientPtr const &	pvaClient,
		PvaClientChannelPtr const &	pvaClientChannel,
		epics::pvData::PVStructurePtr const &	pvRequest )

static

Create a PvaClientMonitor.

Parameters

pvaClient	Interface to PvaClient
pvaClientChannel	Interface to PvaClientChannel
pvRequest	The request structure.

Returns: The interface to the PvaClientMonitor.

◆ create() [2/2]

PvaClientMonitorPtr epics::pvaClient::PvaClientMonitor::create	(	PvaClientPtr const &	pvaClient,
		std::string const &	channelName,
		std::string const &	providerName,
		std::string const &	request,
		PvaClientChannelStateChangeRequesterPtr const &	stateChangeRequester = PvaClientChannelStateChangeRequesterPtr(),
		PvaClientMonitorRequesterPtr const &	monitorRequester = PvaClientMonitorRequesterPtr() )

static

Create a PvaClientMonitor.

Parameters

pvaClient	Interface to PvaClient
channelName	channel name
providerName	provider name
request	The request.
stateChangeRequester	The state change requester. Can be null.
monitorRequester	The monitor requester. Can be null;

Returns: The new instance.

Deprecated: client can create PvaClientMonitor on first channel connect.

Definition at line 90 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug(), and MonitorRequesterImpl.

◆ event()

void epics::pvaClient::PvaClientMonitor::event ( PvaClientMonitorPtr const & monitor )

virtual

A monitor event has occurred.

Parameters

monitor The PvaClientMonitor that received the event.

Implements epics::pvaClient::PvaClientMonitorRequester.

Definition at line 170 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ getData()

PvaClientMonitorDataPtr epics::pvaClient::PvaClientMonitor::getData ( )

The data in which monitor events are placed.

Returns: The interface.

Definition at line 477 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ getPvaClientChannel()

PvaClientChannelPtr epics::pvaClient::PvaClientMonitor::getPvaClientChannel ( )

Get the PvaClientChannel;.

Returns: The interface.

Definition at line 472 of file pvaClientMonitor.cpp.

◆ issueConnect()

void epics::pvaClient::PvaClientMonitor::issueConnect ( )

Issue the channelMonitor connection to the channel.

This can only be called once. An exception is thrown if connect fails.

Exceptions

runtime_error if failure.

Definition at line 312 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

Referenced by connect().

◆ monitorConnect()

virtual void epics::pvaClient::PvaClientMonitorRequester::monitorConnect	(	epics::pvData::Status const &	status,
		PvaClientMonitorPtr const &	monitor,
		epics::pvData::StructureConstPtr const &	structure )

inlinevirtualinherited

The server has returned a message that the monitor is connected.

Parameters

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

Definition at line 1482 of file pvaClient.h.

◆ POINTER_DEFINITIONS() [1/3]

epics::pvaClient::PvaClientChannelStateChangeRequester::POINTER_DEFINITIONS ( PvaClientChannelStateChangeRequester )

inherited

◆ POINTER_DEFINITIONS() [2/3]

epics::pvaClient::PvaClientMonitor::POINTER_DEFINITIONS ( PvaClientMonitor )

◆ POINTER_DEFINITIONS() [3/3]

epics::pvaClient::PvaClientMonitorRequester::POINTER_DEFINITIONS ( PvaClientMonitorRequester )

inherited

◆ poll()

bool epics::pvaClient::PvaClientMonitor::poll ( )

Poll for a monitor event.

The data will be in PvaClientData.

Returns: (false,true) means event (did not, did) occur.

Definition at line 418 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

Referenced by waitEvent().

◆ releaseEvent()

void epics::pvaClient::PvaClientMonitor::releaseEvent ( )

Release the monitorElement returned by poll.

Definition at line 456 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ setRequester()

void epics::pvaClient::PvaClientMonitor::setRequester ( PvaClientMonitorRequesterPtr const & pvaClientMonitorRequester )

Set a user callback.

Parameters

pvaClientMonitorRequester The requester which must be implemented by the caller.

Definition at line 341 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ start() [1/2]

void epics::pvaClient::PvaClientMonitor::start ( )

Start monitoring.

Definition at line 351 of file pvaClientMonitor.cpp.

References connect(), and epics::pvaClient::PvaClient::getDebug().

◆ start() [2/2]

void epics::pvaClient::PvaClientMonitor::start ( const std::string & request )

Start or restart the monitor with a new request.

Parameters

request The new request.

Definition at line 372 of file pvaClientMonitor.cpp.

References connect(), epics::pvaClient::PvaClient::getDebug(), and MonitorRequesterImpl.

◆ stop()

void epics::pvaClient::PvaClientMonitor::stop ( )

Stop monitoring.

Definition at line 406 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

◆ unlisten()

virtual void epics::pvaClient::PvaClientMonitorRequester::unlisten ( )

inlinevirtualinherited

The data source is no longer available.

Definition at line 1495 of file pvaClient.h.

◆ waitConnect()

Status epics::pvaClient::PvaClientMonitor::waitConnect ( )

Wait until the channelMonitor connection to the channel is complete.

Returns: status;

Definition at line 325 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug().

Referenced by connect().

◆ waitEvent()

bool epics::pvaClient::PvaClientMonitor::waitEvent ( double secondsToWait = 0.0 )

Wait for a monitor event.

The data will be in PvaClientData.

Parameters

secondsToWait Time to wait for event.

Returns: (false,true) means event (did not, did) occur.

Definition at line 433 of file pvaClientMonitor.cpp.

References epics::pvaClient::PvaClient::getDebug(), and poll().

Friends And Related Symbol Documentation

◆ MonitorRequesterImpl

friend class MonitorRequesterImpl

friend

Definition at line 1651 of file pvaClient.h.

Referenced by create(), and start().

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

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~PvaClientMonitor()

Member Function Documentation

◆ channelStateChange()

◆ connect()

◆ create() [1/2]

◆ create() [2/2]

◆ event()

◆ getData()

◆ getPvaClientChannel()

◆ issueConnect()

◆ monitorConnect()

◆ POINTER_DEFINITIONS() [1/3]

◆ POINTER_DEFINITIONS() [2/3]

◆ POINTER_DEFINITIONS() [3/3]

◆ poll()

◆ releaseEvent()

◆ setRequester()

◆ start() [1/2]

◆ start() [2/2]

◆ stop()

◆ unlisten()

◆ waitConnect()

◆ waitEvent()

Friends And Related Symbol Documentation

◆ MonitorRequesterImpl