org.epics.pvmanager

Class PVWriterConfiguration<T>

java.lang.Object

org.epics.pvmanager.PVWriterConfiguration<T>

Type Parameters:

T - the type of the expression

public class PVWriterConfiguration<T>
extends Object

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

Author:

carcassi

Method Summary

Methods

Modifier and Type	Method and Description
PVWriter<T>	async() Creates a new PVWriter where the PVWriter.write(java.lang.Object) method is asynchronous (i.e.
PVWriterConfiguration<T>	from(DataSource dataSource) Defines which DataSource should be used to read the data.
PVWriterConfiguration<T>	notifyOn(Executor onThread) Defines on which thread the PVManager should notify the client.
PVWriterConfiguration<T>	routeExceptionsTo(ExceptionHandler exceptionHandler) Forwards exception to the given exception handler.
PVWriter<T>	sync() Creates a new PVWriter where the PVWriter.write(java.lang.Object) method is synchronous (i.e.
PVWriterConfiguration<T>	timeout(org.epics.util.time.TimeDuration timeout) Sets a timeout for write operation.
PVWriterConfiguration<T>	timeout(org.epics.util.time.TimeDuration timeout, String timeoutMessage) Sets a timeout for write operations.
PVWriterConfiguration<T>	writeListener(PVWriterListener<? extends T> listener) Adds a listener notified for any writer event (write result, connection and errors).

Methods inherited from class java.lang.Object

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

Method Detail

from

public PVWriterConfiguration<T> from(DataSource dataSource)

Defines which DataSource should be used to read the data.

Parameters:

dataSource - a connection manager

Returns:

this

notifyOn

public PVWriterConfiguration<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 PVWriterConfiguration<T> timeout(org.epics.util.time.TimeDuration timeout)

Sets a timeout for write operation.

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 PVWriterConfiguration<T> timeout(org.epics.util.time.TimeDuration timeout,
                               String timeoutMessage)

Sets a timeout for write operations.

When a write operation lasts longer than the given timeout, a notification is sent with a TimeoutException. Note that, in the current implementation, the write is not cancelled and may still trigger a second notification. With a synch write, the method returns at the timeout expiration with the exception.

Parameters:

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

timeoutMessage - the message for the reported timeout

Returns:

this expression

writeListener

public PVWriterConfiguration<T> writeListener(PVWriterListener<? extends T> listener)

Adds a listener notified for any writer event (write result, 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 PVWriterConfiguration<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.

Parameters:

exceptionHandler - an exception handler

Returns:

this

sync

public PVWriter<T> sync()

Creates a new PVWriter where the PVWriter.write(java.lang.Object) method is synchronous (i.e. blocking).

Returns:

a new PVWriter

async

public PVWriter<T> async()

Creates a new PVWriter where the PVWriter.write(java.lang.Object) method is asynchronous (i.e. non-blocking).

Returns:

a new PVWriter