org.epics.pvmanager

Class ChannelHandlerWriteSubscription

java.lang.Object

org.epics.pvmanager.ChannelHandlerWriteSubscription

public class ChannelHandlerWriteSubscription
extends Object

Groups all the parameters required to add a writer to a ChannelHandler.

All parameters where grouped in this class so that if something needs to be added or removed the impact is lessened. The class is immutable so that the ChannelHandler can cache it for reference.

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
ChannelHandlerWriteSubscription(WriteCache<?> writeCache, WriteFunction<Exception> exceptionWriteFunction, WriteFunction<Boolean> connectionWriteFunction) Creates a new subscription.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
WriteFunction<Boolean>	getConnectionWriteFunction() The write function for the connection flag.
WriteFunction<Exception>	getExceptionWriteFunction() The write function for connection/disconnection errors.
WriteCache<?>	getWriteCache() The cache to hold the value to write.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelHandlerWriteSubscription

public ChannelHandlerWriteSubscription(WriteCache<?> writeCache,
                               WriteFunction<Exception> exceptionWriteFunction,
                               WriteFunction<Boolean> connectionWriteFunction)

Creates a new subscription.

Parameters:

writeCache - the cache where to read the value from

exceptionWriteFunction - the write function to notify to process errors

connectionWriteFunction - the write function to notify for connection updates

Method Detail

getWriteCache

public WriteCache<?> getWriteCache()

The cache to hold the value to write.

Returns:

the write cache

getExceptionWriteFunction

public WriteFunction<Exception> getExceptionWriteFunction()

The write function for connection/disconnection errors.

Returns:

the write function; never null

getConnectionWriteFunction

public WriteFunction<Boolean> getConnectionWriteFunction()

The write function for the connection flag.

Returns:

the write function; never null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object