org.epics.pvmanager

Class PVConfiguration<R,W>

java.lang.Object

org.epics.pvmanager.PVConfiguration<R,W>

Type Parameters:

R - the read payload

W - the write payload

public class PVConfiguration<R,W>
extends Object

Allows to configure the type of read/write PV to create.

Author:

carcassi

Method Summary

Methods

Modifier and Type	Method and Description
PV<R,W>	asynchWriteAndMaxReadRate(org.epics.util.time.TimeDuration period) Creates the pv such that writes are asynchronous and read notifications comes at most at the rate specified.
PVConfiguration<R,W>	from(DataSource dataSource) Defines which DataSource should be used to read the data.
PVConfiguration<R,W>	notifyOn(Executor onThread) Defines on which thread the PVManager should notify the client.
PVConfiguration<R,W>	readListener(PVReaderListener<? super R> listener) Adds a listener for the read events.
PVConfiguration<R,W>	routeExceptionsTo(ExceptionHandler exceptionHandler) Forwards exception to the given exception handler.
PV<R,W>	synchWriteAndMaxReadRate(org.epics.util.time.TimeDuration period) Creates the pv such that writes are synchronous and read notifications comes at most at the rate specified.
PVConfiguration<R,W>	timeout(org.epics.util.time.TimeDuration timeout) Sets a timeout for both reader and writer.
PVConfiguration<R,W>	timeout(org.epics.util.time.TimeDuration timeout, String timeoutMessage) Sets a timeout with the given message for both read and writer.
PVConfiguration<R,W>	timeout(org.epics.util.time.TimeDuration timeout, String readMessage, String writeMessage) Specifies a timeout, with a different message for the read and the write.
PVConfiguration<R,W>	writeListener(PVWriterListener<? extends W> listener) Adds a listener for the write events.

Methods inherited from class java.lang.Object

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

Method Detail

from

public PVConfiguration<R,W> from(DataSource dataSource)

Defines which DataSource should be used to read the data.

Parameters:

dataSource - a connection manager

Returns:

this

notifyOn

public PVConfiguration<R,W> 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 PVConfiguration<R,W> timeout(org.epics.util.time.TimeDuration timeout)

Sets a timeout for both reader and writer.

Parameters:

timeout - duration of the timeout

Returns:

this expression

timeout

public PVConfiguration<R,W> timeout(org.epics.util.time.TimeDuration timeout,
                           String timeoutMessage)

Sets a timeout with the given message for both read and writer.

Parameters:

timeout - duration of the timeout

timeoutMessage - message for the timeout

Returns:

this expression

timeout

public PVConfiguration<R,W> timeout(org.epics.util.time.TimeDuration timeout,
                           String readMessage,
                           String writeMessage)

Specifies a timeout, with a different message for the read and the write.

Parameters:

timeout - time before notification

readMessage - exception message for the read timeout

writeMessage - exception message for the write timeout

Returns:

this

readListener

public PVConfiguration<R,W> readListener(PVReaderListener<? super R> listener)

Adds a listener for the read events.

Parameters:

listener - the new listener

Returns:

this expression

writeListener

public PVConfiguration<R,W> writeListener(PVWriterListener<? extends W> listener)

Adds a listener for the write events.

Parameters:

listener - the new listener

Returns:

this expression

routeExceptionsTo

public PVConfiguration<R,W> 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 PV.lastException() and PV.lastWriteException() is no longer set and no notification is done.

Parameters:

exceptionHandler - an exception handler

Returns:

this

synchWriteAndMaxReadRate

public PV<R,W> synchWriteAndMaxReadRate(org.epics.util.time.TimeDuration period)

Creates the pv such that writes are synchronous and read notifications comes at most at the rate specified.

Parameters:

period - minimum time between read notifications

Returns:

a new PV

asynchWriteAndMaxReadRate

public PV<R,W> asynchWriteAndMaxReadRate(org.epics.util.time.TimeDuration period)

Creates the pv such that writes are asynchronous and read notifications comes at most at the rate specified.

Parameters:

period - minimum time between read notifications

Returns:

a new PV