org.diirt.support.pva

Class PVAChannelHandler

java.lang.Object

org.diirt.datasource.ChannelHandler

org.diirt.datasource.MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

org.diirt.support.pva.PVAChannelHandler

All Implemented Interfaces:

org.epics.pvaccess.client.ChannelPutRequester, org.epics.pvaccess.client.ChannelRequester, org.epics.pvaccess.client.GetFieldRequester, org.epics.pvdata.monitor.MonitorRequester, org.epics.pvdata.pv.Requester

public class PVAChannelHandler
extends MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>
implements org.epics.pvaccess.client.ChannelRequester, org.epics.pvaccess.client.GetFieldRequester, org.epics.pvaccess.client.ChannelPutRequester, org.epics.pvdata.monitor.MonitorRequester

Author:

msekoranja

Constructor Summary

Constructors

Constructor and Description
PVAChannelHandler(String channelName, String pvRequestString, org.epics.pvaccess.client.ChannelProvider channelProvider, short priority, PVATypeSupport typeSupport)

Method Summary

Modifier and Type	Method and Description
void	addReader(ChannelHandlerReadSubscription subscription) Used by the data source to add a read request on the channel managed by this handler.
void	channelCreated(org.epics.pvdata.pv.Status status, org.epics.pvaccess.client.Channel channel)
void	channelPutConnect(org.epics.pvdata.pv.Status status, org.epics.pvaccess.client.ChannelPut channelPut, org.epics.pvdata.pv.Structure putStructure)
void	channelStateChange(org.epics.pvaccess.client.Channel channel, org.epics.pvaccess.client.Channel.ConnectionState connectionState)
void	connect() Used by the handler to open the connection.
static PVAChannelHandler	create(String channelName, org.epics.pvaccess.client.ChannelProvider channelProvider, short priority, PVATypeSupport typeSupport)
void	disconnect() Used by the handler to close the connection.
protected PVATypeAdapter	findTypeAdapter(ValueCache<?> cache, PVAChannelHandler connection) Finds the right adapter to use for the particular cache given the information of the channels in the connection payload.
org.epics.pvaccess.client.Channel	getChannel()
org.epics.pvdata.pv.Field	getChannelType()
void	getDone(org.epics.pvdata.pv.Status status, org.epics.pvaccess.client.ChannelPut channelPut, org.epics.pvdata.pv.PVStructure pvStructure, org.epics.pvdata.misc.BitSet bitSet)
void	getDone(org.epics.pvdata.pv.Status status, org.epics.pvdata.pv.Field field)
String	getExtractFieldName()
Map<String,Object>	getProperties() Returns extra information about the channel, typically useful for debugging.
String	getRequesterName()
boolean	isConnected(PVAChannelHandler channel) Determines from the payload whether the channel is connected or not.
protected boolean	isWriteConnected(PVAChannelHandler channel) Determines from the payload whether the channel can be written to.
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)
void	putDone(org.epics.pvdata.pv.Status status, org.epics.pvaccess.client.ChannelPut channePut)
static Level	toLoggerLevel(org.epics.pvdata.pv.MessageType messageType) Converts MessageType to Java Logging API Level.
String	toString()
void	unlisten(org.epics.pvdata.monitor.Monitor monitor)
void	write(Object newValue, ChannelWriteCallback callback) Implements a write operation.

Methods inherited from class org.diirt.datasource.MultiplexedChannelHandler

addWriter, getConnectionPayload, getLastMessagePayload, getReadUsageCounter, getUsageCounter, getWriteUsageCounter, isConnected, isWriteConnected, processConnection, processMessage, removeReader, removeWrite, reportExceptionToAllReadersAndWriters, reportExceptionToAllWriters, resetMessage, saveMessageAfterDisconnect, setProcessMessageOnDisconnect, setProcessMessageOnReconnect

Methods inherited from class org.diirt.datasource.ChannelHandler

getChannelName

Methods inherited from class java.lang.Object

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

Constructor Detail

PVAChannelHandler

public PVAChannelHandler(String channelName,
                         String pvRequestString,
                         org.epics.pvaccess.client.ChannelProvider channelProvider,
                         short priority,
                         PVATypeSupport typeSupport)

Method Detail

create

public static PVAChannelHandler create(String channelName,
                                       org.epics.pvaccess.client.ChannelProvider channelProvider,
                                       short priority,
                                       PVATypeSupport typeSupport)

getChannel

public org.epics.pvaccess.client.Channel getChannel()

Returns:

the channel

getChannelType

public org.epics.pvdata.pv.Field getChannelType()

Returns:

the channelType

getExtractFieldName

public String getExtractFieldName()

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

toLoggerLevel

public static Level toLoggerLevel(org.epics.pvdata.pv.MessageType messageType)

Converts MessageType to Java Logging API Level.

Parameters:

messageType - pvData message type.

Returns:

Corresponded Java Logging API Level.

connect

public void connect()

Description copied from class: MultiplexedChannelHandler

Used by the handler to open the connection. This is called whenever the first read or write request is made.

Specified by:

connect in class MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

channelCreated

public void channelCreated(org.epics.pvdata.pv.Status status,
                           org.epics.pvaccess.client.Channel channel)

Specified by:

channelCreated in interface org.epics.pvaccess.client.ChannelRequester

channelStateChange

public void channelStateChange(org.epics.pvaccess.client.Channel channel,
                               org.epics.pvaccess.client.Channel.ConnectionState connectionState)

Specified by:

channelStateChange in interface org.epics.pvaccess.client.ChannelRequester

getDone

public void getDone(org.epics.pvdata.pv.Status status,
                    org.epics.pvdata.pv.Field field)

Specified by:

getDone in interface org.epics.pvaccess.client.GetFieldRequester

isConnected

public boolean isConnected(PVAChannelHandler channel)

Description copied from class: MultiplexedChannelHandler

Determines from the payload whether the channel is connected or not.

By default, this uses the usage counter to determine whether it's connected or not. One should override this to use the actual connection payload to check whether the actual protocol connection has been established.

Overrides:

isConnected in class MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Parameters:

channel - the connection payload

Returns:

true if connected

isWriteConnected

protected boolean isWriteConnected(PVAChannelHandler channel)

Description copied from class: MultiplexedChannelHandler

Determines from the payload whether the channel can be written to.

By default, this always return false. One should override this if it's implementing a write-able data source.

Overrides:

isWriteConnected in class MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Parameters:

channel - connection payload; not null

Returns:

true if ready for writes

getProperties

public Map<String,Object> getProperties()

Description copied from class: ChannelHandler

Returns extra information about the channel, typically useful for debugging.

Overrides:

getProperties in class ChannelHandler

Returns:

a property map

disconnect

public void disconnect()

Description copied from class: MultiplexedChannelHandler

Used by the handler to close the connection. This is called whenever the last reader or writer is de-registered.

Specified by:

disconnect in class MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

write

public void write(Object newValue,
                  ChannelWriteCallback callback)

Description copied from class: ChannelHandler

Implements a write operation. Writes the newValues to the channel and call the callback when done.

Specified by:

write in class MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Parameters:

newValue - new value to be written

callback - called when done or on error

channelPutConnect

public void channelPutConnect(org.epics.pvdata.pv.Status status,
                              org.epics.pvaccess.client.ChannelPut channelPut,
                              org.epics.pvdata.pv.Structure putStructure)

Specified by:

channelPutConnect in interface org.epics.pvaccess.client.ChannelPutRequester

putDone

public void putDone(org.epics.pvdata.pv.Status status,
                    org.epics.pvaccess.client.ChannelPut channePut)

Specified by:

putDone in interface org.epics.pvaccess.client.ChannelPutRequester

getDone

public void getDone(org.epics.pvdata.pv.Status status,
                    org.epics.pvaccess.client.ChannelPut channelPut,
                    org.epics.pvdata.pv.PVStructure pvStructure,
                    org.epics.pvdata.misc.BitSet bitSet)

Specified by:

getDone in interface org.epics.pvaccess.client.ChannelPutRequester

findTypeAdapter

protected PVATypeAdapter findTypeAdapter(ValueCache<?> cache,
                                         PVAChannelHandler connection)

Description copied from class: MultiplexedChannelHandler

Finds the right adapter to use for the particular cache given the information of the channels in the connection payload. By overriding this method a datasource can implement their own matching logic. One can use the logic provided in DataSourceTypeSupport as a good first implementation.

Overrides:

findTypeAdapter in class MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Parameters:

cache - the cache that will store the data

connection - the connection payload

Returns:

the matched type adapter

addReader

public void addReader(ChannelHandlerReadSubscription subscription)

Description copied from class: ChannelHandler

Used by the data source to add a read request on the channel managed by this handler.

Overrides:

addReader in class MultiplexedChannelHandler<PVAChannelHandler,org.epics.pvdata.pv.PVStructure>

Parameters:

subscription - the data required for a subscription

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

toString

public String toString()

Overrides:

toString in class Object