org.epics.pvmanager

Class PVReaderConfiguration<T>

java.lang.Object

org.epics.pvmanager.PVReaderConfiguration<T>

Type Parameters:

T - the type of the expression

public class PVReaderConfiguration<T>
extends Object

An expression used to set the final parameters on how the pv expression should be read.

Author:

carcassi

Method Summary

Methods

Modifier and Type	Method and Description
PVReaderConfiguration<T>	from(DataSource dataSource) Defines which DataSource should be used to read the data.
PVReader<T>	maxRate(org.epics.util.time.TimeDuration rate) Sets the rate of scan of the expression and creates the actual PVReader object that can be monitored through listeners.
PVReaderConfiguration<T>	notifyOn(Executor onThread) Defines on which thread the PVManager should notify the client.
PVReaderConfiguration<T>	readListener(PVReaderListener<? super T> listener) Adds a listener notified for any reader event (values, connection and errors).
PVReaderConfiguration<T>	routeExceptionsTo(ExceptionHandler exceptionHandler) Forwards exception to the given exception handler.
PVReaderConfiguration<T>	timeout(org.epics.util.time.TimeDuration timeout) Sets a timeout for no values received.
PVReaderConfiguration<T>	timeout(org.epics.util.time.TimeDuration timeout, String timeoutMessage) Sets a timeout for no values received with the given message.

Methods inherited from class java.lang.Object

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

Method Detail

from

public PVReaderConfiguration<T> from(DataSource dataSource)

Defines which DataSource should be used to read the data.

Parameters:

dataSource - a connection manager

Returns:

this

notifyOn

public PVReaderConfiguration<T> notifyOn(Executor onThread)

Defines on which thread the PVManager should notify the client.

Parameters:

onThread - the thread on which to notify

Returns:

this

timeout

public PVReaderConfiguration<T> timeout(org.epics.util.time.TimeDuration timeout)

Sets a timeout for no values received.

For more details, consult timeout(org.epics.util.time.TimeDuration, java.lang.String).

Parameters:

timeout - the duration of the timeout; can't be null

Returns:

this expression

timeout

public PVReaderConfiguration<T> timeout(org.epics.util.time.TimeDuration timeout,
                               String timeoutMessage)

Sets a timeout for no values received with the given message.

If no value is received before the given time, a TimeoutException is notified through the listener. Note the difference: the timeout is not on the connection but on the value itself. This allows to use timeouts when creating combined expressions that can produce data even if not all elements have values. For single channels, this means that if the channel is connected, but no value has been processed, a timeout exception is still sent.

Parameters:

timeout - the duration of the timeout; can't be null

timeoutMessage - the message for the reported timeout

Returns:

this expression

readListener

public PVReaderConfiguration<T> readListener(PVReaderListener<? super T> listener)

Adds a listener notified for any reader event (values, connection and errors).

Registering a listener here guarantees that no event is ever missed.

Parameters:

listener - the listener to register

Returns:

this expression

routeExceptionsTo

public PVReaderConfiguration<T> routeExceptionsTo(ExceptionHandler exceptionHandler)

Forwards exception to the given exception handler. No thread switch is done, so the handler is notified on the thread where the exception was thrown.

Giving a custom exception handler will disable the default handler, so PVReader.lastException() is no longer set and no notification is done.

Parameters:

exceptionHandler - an exception handler

Returns:

this

maxRate

public PVReader<T> maxRate(org.epics.util.time.TimeDuration rate)

Sets the rate of scan of the expression and creates the actual PVReader object that can be monitored through listeners.

Parameters:

rate - the minimum time distance (i.e. the maximum rate) between two different notifications

Returns:

the PVReader