org.epics.pvaClient

Class PvaClientChannel

java.lang.Object

org.epics.pvaClient.PvaClientChannel

All Implemented Interfaces:

org.epics.pvaccess.client.ChannelRequester, org.epics.pvdata.pv.Requester

public class PvaClientChannel
extends Object
implements org.epics.pvaccess.client.ChannelRequester, org.epics.pvdata.pv.Requester

An synchronous alternative to directly calling the Channel methods of pvAccess.

Since:

2015.06

Author:

mrk

Method Summary

Modifier and Type	Method and Description
int	cacheSize() Get the number of cached gets and puts.
void	channelCreated(org.epics.pvdata.pv.Status status, org.epics.pvaccess.client.Channel channel)
void	channelStateChange(org.epics.pvaccess.client.Channel channel, org.epics.pvaccess.client.Channel.ConnectionState connectionState)
void	clearRequester() Clear user callback for change of state.
void	connect() connect with timeout set to 5 seconds.
void	connect(double timeout) Connect to the channel.
PvaClientArray	createArray() Call the next method with request = "field(value)";
PvaClientArray	createArray(org.epics.pvdata.pv.PVStructure pvRequest) Create a pvaClientArray.
PvaClientArray	createArray(String request) First call createRequest as implemented by pvDataJava and then calls the next method.
PvaClientField	createField() Calls the next method with subField = "";
PvaClientField	createField(String subField) Create an PvaClientField for the specified subField.
PvaClientGet	createGet() Call the next method with request = "value,alarm,timeStamp"
PvaClientGet	createGet(org.epics.pvdata.pv.PVStructure pvRequest) Creates a pvaClientGet.
PvaClientGet	createGet(String request) First call createRequest as implemented by pvDataJava and then calls the next method.
PvaClientMonitor	createMonitor() Call the next method with request = "field(value.alarm,timeStamp)"
PvaClientMonitor	createMonitor(org.epics.pvdata.pv.PVStructure pvRequest) Create an PvaClientMonitor.
PvaClientMonitor	createMonitor(String request) First call createRequest as implemented by pvDataJava and then calls the next method.
PvaClientProcess	createProcess() Calls the next method with request = "";
PvaClientProcess	createProcess(org.epics.pvdata.pv.PVStructure pvRequest) Creates a PvaClientProcess.
PvaClientProcess	createProcess(String request) First call createRequest as implemented by pvDataJava and then calls the next method.
PvaClientPut	createPut() Call the next method with request = "field(value)"
PvaClientPut	createPut(org.epics.pvdata.pv.PVStructure pvRequest) Create an PvaClientPut.
PvaClientPut	createPut(String request) First call createRequest as implemented by pvDataJava and then calls the next method.
PvaClientPutGet	createPutGet() Call the next method with request = "record[process=true]putField(argument)getField(result)".
PvaClientPutGet	createPutGet(org.epics.pvdata.pv.PVStructure pvRequest) Create an PvaClientPutGet.
PvaClientPutGet	createPutGet(String request) First call createRequest as implemented by pvDataJava and then calls the next method.
PvaClientRPC	createRPC() Create a PvaClientRPC.
PvaClientRPC	createRPC(org.epics.pvdata.pv.PVStructure pvRequest) Create a PvaClientRPC.
void	destroy() Destroy the pvAccess connection and all cached gets and puts.
PvaClientGet	get() Call the next method with request = "value,alarm,timeStamp"
PvaClientGet	get(String request) Get a cached PvaClientGet or create and connect to a new PvaClientGet.
org.epics.pvaccess.client.Channel	getChannel() Get the Channel to which pvaClientChannel is connected.
String	getChannelName() Get the name of the channel to which pvaClientChannel is connected.
String	getRequesterName()
void	issueConnect() Issue a connect request and return immediately.
void	message(String message, org.epics.pvdata.pv.MessageType messageType)
PvaClientMonitor	monitor() Call the next method with request = "value,alarm,timeStamp"
PvaClientMonitor	monitor(PvaClientMonitorRequester pvaClientMonitorRequester) Call the next method with request = "value,alarm,timeStamp"
PvaClientMonitor	monitor(PvaClientMonitorRequester pvaClientMonitorRequester, PvaClientUnlistenRequester pvaClientListenerRequester) Call the next method with request = "value,alarm,timeStamp"
PvaClientMonitor	monitor(String request) Get a cached PvaClientMonitor or create and connect to a new PvaClientMonitor.
PvaClientMonitor	monitor(String request, PvaClientMonitorRequester pvaClientMonitorRequester) Create and connect to a new PvaClientMonitor.
PvaClientMonitor	monitor(String request, PvaClientMonitorRequester pvaClientMonitorRequester, PvaClientUnlistenRequester pvaClientListenerRequester) Create and connect to a new PvaClientMonitor.
PvaClientPut	put() Call the next method with request = "field(value)"
PvaClientPut	put(String request) Get a cached PvaClientPut or create and connect to a new PvaClientPut.
org.epics.pvdata.pv.PVStructure	rpc(org.epics.pvdata.pv.PVStructure pvArgument) Issue a channelRPC request
org.epics.pvdata.pv.PVStructure	rpc(org.epics.pvdata.pv.PVStructure pvRequest, org.epics.pvdata.pv.PVStructure pvArgument) Issue a channelRPC request
void	setStateChangeRequester(PvaClientChannelStateChangeRequester stateChangeRequester) Set a user callback for change of state.
String	showCache() Show the list of cached gets and puts.
org.epics.pvdata.pv.Status	waitConnect() Wait until the connection completes or for timeout.
org.epics.pvdata.pv.Status	waitConnect(double timeout) Wait until the connection completes or for timeout.

Methods inherited from class java.lang.Object

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

Method Detail

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

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

destroy

public void destroy()

Destroy the pvAccess connection and all cached gets and puts.

getChannelName

public String getChannelName()

Get the name of the channel to which pvaClientChannel is connected.

Returns:

The channel name.

getChannel

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

Get the Channel to which pvaClientChannel is connected.

Returns:

The channel.

setStateChangeRequester

public void setStateChangeRequester(PvaClientChannelStateChangeRequester stateChangeRequester)

Set a user callback for change of state.

Parameters:

stateChangeRequester - The user supplied requester.

clearRequester

public void clearRequester()

Clear user callback for change of state.

connect

public void connect()

connect with timeout set to 5 seconds.

connect

public void connect(double timeout)

Connect to the channel. This calls issueConnect and waitConnect.

Parameters:

timeout - The time to wait for connecting to the channel. A value of 0.0 means forever.

Throws:

RuntimeException - if connection fails.

issueConnect

public void issueConnect()

Issue a connect request and return immediately.

waitConnect

public org.epics.pvdata.pv.Status waitConnect()

Wait until the connection completes or for timeout. If failure getStatus can be called to get reason This calls the next method with a time out of 5 seconds.

Returns:

status of connect request.

waitConnect

public org.epics.pvdata.pv.Status waitConnect(double timeout)

Wait until the connection completes or for timeout. If failure getStatus can be called to get reason.

Parameters:

timeout - The time in second to wait. A value of 0 means forever.

Returns:

status of connect request.

createField

public PvaClientField createField()

Calls the next method with subField = "";

Returns:

The interface.

createField

public PvaClientField createField(String subField)

Create an PvaClientField for the specified subField.

Parameters:

subField - The syntax for subField is defined in package org.epics.pvdata.copy

Returns:

The interface.

createProcess

public PvaClientProcess createProcess()

Calls the next method with request = "";

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createProcess

public PvaClientProcess createProcess(String request)

First call createRequest as implemented by pvDataJava and then calls the next method.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createProcess

public PvaClientProcess createProcess(org.epics.pvdata.pv.PVStructure pvRequest)

Creates a PvaClientProcess.

Parameters:

pvRequest - The syntax of pvRequest is described in package org.epics.pvdata.copy.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

get

public PvaClientGet get()

Call the next method with request = "value,alarm,timeStamp"

Returns:

The interface.

Throws:

RuntimeException - if create fails.

get

public PvaClientGet get(String request)

Get a cached PvaClientGet or create and connect to a new PvaClientGet. Then call it's get method. If connection or get can not be made an exception is thrown.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createGet

public PvaClientGet createGet()

Call the next method with request = "value,alarm,timeStamp"

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createGet

public PvaClientGet createGet(String request)

First call createRequest as implemented by pvDataJava and then calls the next method.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createGet

public PvaClientGet createGet(org.epics.pvdata.pv.PVStructure pvRequest)

Creates a pvaClientGet.

Parameters:

pvRequest - The syntax of pvRequest is described in package org.epics.pvdata.copy.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

put

public PvaClientPut put()

Call the next method with request = "field(value)"

Returns:

The interface.

Throws:

RuntimeException - if create fails.

put

public PvaClientPut put(String request)

Get a cached PvaClientPut or create and connect to a new PvaClientPut. Then call it's get method. If connection can not be made an exception is thrown.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createPut

public PvaClientPut createPut()

Call the next method with request = "field(value)"

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createPut

public PvaClientPut createPut(String request)

First call createRequest as implemented by pvDataJava and then calls the next method.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createPut

public PvaClientPut createPut(org.epics.pvdata.pv.PVStructure pvRequest)

Create an PvaClientPut.

Parameters:

pvRequest - The syntax of pvRequest is described in package org.epics.pvdata.copy.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createPutGet

public PvaClientPutGet createPutGet()

Call the next method with request = "record[process=true]putField(argument)getField(result)".

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createPutGet

public PvaClientPutGet createPutGet(String request)

First call createRequest as implemented by pvDataJava and then calls the next method.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createPutGet

public PvaClientPutGet createPutGet(org.epics.pvdata.pv.PVStructure pvRequest)

Create an PvaClientPutGet.

Parameters:

pvRequest - The syntax of pvRequest is described in package org.epics.pvdata.copy.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createArray

public PvaClientArray createArray()

Call the next method with request = "field(value)";

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createArray

public PvaClientArray createArray(String request)

First call createRequest as implemented by pvDataJava and then calls the next method.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createArray

public PvaClientArray createArray(org.epics.pvdata.pv.PVStructure pvRequest)

Create a pvaClientArray.

Parameters:

pvRequest - The syntax of pvRequest is described in package org.epics.pvdata.copy.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

monitor

public PvaClientMonitor monitor()

Call the next method with request = "value,alarm,timeStamp"

Returns:

The interface.

Throws:

RuntimeException - if create fails.

monitor

public PvaClientMonitor monitor(String request)

Get a cached PvaClientMonitor or create and connect to a new PvaClientMonitor. Then call it's start method. If connection can not be made an exception is thrown.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

monitor

public PvaClientMonitor monitor(PvaClientMonitorRequester pvaClientMonitorRequester)

Call the next method with request = "value,alarm,timeStamp"

Parameters:

pvaClientMonitorRequester - The client callback.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

monitor

public PvaClientMonitor monitor(String request,
                                PvaClientMonitorRequester pvaClientMonitorRequester)

Create and connect to a new PvaClientMonitor. Then call it's start method. If connection can not be made an exception is thrown.

Parameters:

request - The request as described in package org.epics.pvdata.copy

pvaClientMonitorRequester - The client callback.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

monitor

public PvaClientMonitor monitor(PvaClientMonitorRequester pvaClientMonitorRequester,
                                PvaClientUnlistenRequester pvaClientListenerRequester)

Call the next method with request = "value,alarm,timeStamp"

Parameters:

pvaClientMonitorRequester - The client callback.

pvaClientListenerRequester - The client callback.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

monitor

public PvaClientMonitor monitor(String request,
                                PvaClientMonitorRequester pvaClientMonitorRequester,
                                PvaClientUnlistenRequester pvaClientListenerRequester)

Create and connect to a new PvaClientMonitor. Then call it's start method. If connection can not be made an exception is thrown.

Parameters:

request - The request as described in package org.epics.pvdata.copy

pvaClientMonitorRequester - The client callback.

pvaClientListenerRequester - The client callback.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createMonitor

public PvaClientMonitor createMonitor()

Call the next method with request = "field(value.alarm,timeStamp)"

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createMonitor

public PvaClientMonitor createMonitor(String request)

First call createRequest as implemented by pvDataJava and then calls the next method.

Parameters:

request - The request as described in package org.epics.pvdata.copy

Returns:

The interface.

Throws:

RuntimeException - if create fails.

createMonitor

public PvaClientMonitor createMonitor(org.epics.pvdata.pv.PVStructure pvRequest)

Create an PvaClientMonitor.

Parameters:

pvRequest - The syntax of pvRequest is described in package org.epics.pvdata.copy.

Returns:

The interface.

Throws:

RuntimeException - if create fails.

rpc

public org.epics.pvdata.pv.PVStructure rpc(org.epics.pvdata.pv.PVStructure pvRequest,
                                           org.epics.pvdata.pv.PVStructure pvArgument)

Issue a channelRPC request

Parameters:

pvRequest - The pvRequest that is passed to createRPC.

pvArgument - The argument for a request.

Returns:

The result.

rpc

public org.epics.pvdata.pv.PVStructure rpc(org.epics.pvdata.pv.PVStructure pvArgument)

Issue a channelRPC request

Parameters:

pvArgument - The argument for the request.

Returns:

The result.

createRPC

public PvaClientRPC createRPC()

Create a PvaClientRPC.

Returns:

The interface.

createRPC

public PvaClientRPC createRPC(org.epics.pvdata.pv.PVStructure pvRequest)

Create a PvaClientRPC.

Parameters:

pvRequest - The pvRequest that must have the same interface as a pvArgument that is passed to an rpc request.

Returns:

The interface.

showCache

public String showCache()

Show the list of cached gets and puts.

Returns:

A String showing the current cache.

cacheSize

public int cacheSize()

Get the number of cached gets and puts.

Returns:

The size.