org.epics.pvaClient

Class PvaClientRPC

java.lang.Object

org.epics.pvaClient.PvaClientRPC

All Implemented Interfaces:

ChannelRPCRequester, Requester

public class PvaClientRPC
extends Object
implements ChannelRPCRequester

This is a synchronous alternative to channelRPC.

Since:

2016.06

Author:

mrk

Method Summary

Modifier and Type	Method and Description
void	channelRPCConnect(Status status, ChannelRPC channelRPC)
void	connect() call issueConnect and then waitConnect.
void	destroy() clean up resources used.
String	getRequesterName()
double	getResponseTimeout() Get the responseTimeout.
void	issueConnect() create the channelRPC connection to the channel.
void	message(String message, MessageType messageType)
PVStructure	request(PVStructure pvArgument) Issue a request.
void	request(PVStructure pvArgument, PvaClientRPCRequester pvaClientRPCRequester) Issue a request.
void	requestDone(Status status, ChannelRPC channelRPC, PVStructure pvResponse)
void	setResponseTimeout(double responseTimeout) Set a timeout for a request.
Status	waitConnect() wait until the channelRPC connection to the channel is complete.

Methods inherited from class java.lang.Object

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

Method Detail

getRequesterName

public String getRequesterName()

Specified by:

getRequesterName in interface Requester

message

public void message(String message,
                    MessageType messageType)

Specified by:

message in interface Requester

channelRPCConnect

public void channelRPCConnect(Status status,
                              ChannelRPC channelRPC)

Specified by:

channelRPCConnect in interface ChannelRPCRequester

requestDone

public void requestDone(Status status,
                        ChannelRPC channelRPC,
                        PVStructure pvResponse)

Specified by:

requestDone in interface ChannelRPCRequester

destroy

public void destroy()

clean up resources used.

setResponseTimeout

public void setResponseTimeout(double responseTimeout)

Set a timeout for a request.

Parameters:

responseTimeout - The time in seconds to wait for a request to complete.

getResponseTimeout

public double getResponseTimeout()

Get the responseTimeout.

Returns:

The value.

connect

public void connect()

call issueConnect and then waitConnect.

Throws:

RuntimeException - if create fails.

issueConnect

public void issueConnect()

create the channelRPC connection to the channel. This can only be called once.

waitConnect

public Status waitConnect()

wait until the channelRPC connection to the channel is complete.

Returns:

status of connection request.

request

public PVStructure request(PVStructure pvArgument)

Issue a request.

Parameters:

pvArgument - The argument for the request.

Returns:

The result.

request

public void request(PVStructure pvArgument,
                    PvaClientRPCRequester pvaClientRPCRequester)

Issue a request. Note that if responseTimeout is ( lt 0.0, ge 0.0) then this (will, will not) block until response completes or timeout.

Parameters:

pvArgument - The argument for the request.

pvaClientRPCRequester - The client requester to call when the request completes.