org.epics.pvaClient

Class PvaClientMonitor

java.lang.Object

org.epics.pvaClient.PvaClientMonitor

All Implemented Interfaces:

org.epics.pvdata.monitor.MonitorRequester, org.epics.pvdata.pv.Requester

public class PvaClientMonitor
extends Object
implements org.epics.pvdata.monitor.MonitorRequester

This is a synchronous alternative to channel monitor.

Since:

2015.06

Author:

mrk

Method Summary

Modifier and Type	Method and Description
void	connect() call issueConnect and then waitConnect.
void	destroy() clean up resources used.
PvaClientMonitorData	getData() Get the data in which monitor events are placed.
String	getRequesterName()
void	issueConnect() create the monitor connection to the channel.
void	message(String message, org.epics.pvdata.pv.MessageType messageType)
void	monitorConnect(org.epics.pvdata.pv.Status status, org.epics.pvdata.monitor.Monitor monitor, org.epics.pvdata.pv.Structure structure)
void	monitorEvent(org.epics.pvdata.monitor.Monitor monitor)
boolean	poll() Is new monitor data available.
void	releaseEvent() Release the monitorElement returned by poll.
void	setRequester(PvaClientMonitorRequester requester) Optional request to be notified when monitors occur.
void	setUnlistenRequester(PvaClientUnlistenRequester requester) Optional request to be notified when unlisten occur.
void	start() Start monitoring.
void	stop() Stop monitoring.
void	unlisten(org.epics.pvdata.monitor.Monitor monitor)
org.epics.pvdata.pv.Status	waitConnect() wait until the monitor connection to the channel is complete.
boolean	waitEvent(double secondsToWait) Wait for a monitor event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRequesterName

public String getRequesterName()

Specified by:

getRequesterName in interface org.epics.pvdata.pv.Requester

message

public void message(String message,
                    org.epics.pvdata.pv.MessageType messageType)

Specified by:

message in interface org.epics.pvdata.pv.Requester

monitorConnect

public void monitorConnect(org.epics.pvdata.pv.Status status,
                           org.epics.pvdata.monitor.Monitor monitor,
                           org.epics.pvdata.pv.Structure structure)

Specified by:

monitorConnect in interface org.epics.pvdata.monitor.MonitorRequester

monitorEvent

public void monitorEvent(org.epics.pvdata.monitor.Monitor monitor)

Specified by:

monitorEvent in interface org.epics.pvdata.monitor.MonitorRequester

unlisten

public void unlisten(org.epics.pvdata.monitor.Monitor monitor)

Specified by:

unlisten in interface org.epics.pvdata.monitor.MonitorRequester

destroy

public void destroy()

clean up resources used.

connect

public void connect()

call issueConnect and then waitConnect.

Throws:

RuntimeException - if create fails.

issueConnect

public void issueConnect()

create the monitor connection to the channel. This can only be called once.

Throws:

RuntimeException - if failure.

waitConnect

public org.epics.pvdata.pv.Status waitConnect()

wait until the monitor connection to the channel is complete.

Returns:

status of connection request.

setRequester

public void setRequester(PvaClientMonitorRequester requester)

Optional request to be notified when monitors occur.

Parameters:

requester - The requester which must be implemented by the caller.

setUnlistenRequester

public void setUnlistenRequester(PvaClientUnlistenRequester requester)

Optional request to be notified when unlisten occur.

Parameters:

requester - The requester which must be implemented by the caller.

start

public void start()

Start monitoring. This will wait until the monitor is connected.

stop

public void stop()

Stop monitoring.

poll

public boolean poll()

Is new monitor data available. If true then getData can be called to get the data. Also after done with data releaseEvent must be called before another call to poll or waitEvent.

Returns:

true if monitor data is available or false if no new monitorElement are present.

waitEvent

public boolean waitEvent(double secondsToWait)

Wait for a monitor event. If true then getData can be called to get the data. Also after done with data releaseEvent must be called before another call to poll or waitEvent.

Parameters:

secondsToWait - Time to wait for event.

Returns:

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

releaseEvent

public void releaseEvent()

Release the monitorElement returned by poll.

getData

public PvaClientMonitorData getData()

Get the data in which monitor events are placed.

Returns:

The interface.