org.epics.pvaClient

Class PvaClient

java.lang.Object

org.epics.pvaClient.PvaClient

All Implemented Interfaces:

org.epics.pvdata.pv.Requester

public class PvaClient
extends Object
implements org.epics.pvdata.pv.Requester

PvaClient is a synchronous interface to pvAccess.

Since:

2015.06

Author:

mrk

Constructor Summary

Constructors

Constructor and Description
PvaClient()

Method Summary

Modifier and Type	Method and Description
int	cacheSize() Get the number of cached gets and puts.
PvaClientChannel	channel(String channelName) Get a cached channel or create and connect to a new channel.
PvaClientChannel	channel(String channelName, String providerName) Get a cached channel or create and connect to a new channel.
PvaClientChannel	channel(String channelName, String providerName, double timeOut) Get a cached channel or create and connect to a new channel.
void	clearRequester() Clear the requester.
PvaClientChannel	createChannel(String channelName) Create an PvaClientChannel.
PvaClientChannel	createChannel(String channelName, String providerName) Create an PvaClientChannel with the specified provider.
void	destroy() Destroy all cached channels.
static PvaClient	get() Get the single instance of PvaClient.
static PvaClient	get(String providerNames) Get the single instance of PvaClient.
static boolean	getDebug() Is debug set?
String	getRequesterName()
void	message(String message, org.epics.pvdata.pv.MessageType messageType)
static void	setDebug(boolean value) Should debug info be shown?
void	setRequester(org.epics.pvdata.pv.Requester requester) Set a requester.
String	showCache() Show the list of cached gets and puts.

Methods inherited from class java.lang.Object

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

Constructor Detail

PvaClient

public PvaClient()

Method Detail

get

public static PvaClient get(String providerNames)

Get the single instance of PvaClient.

Parameters:

providerNames - - space separated list of provider names.

Returns:

The interface to PvaClient.

get

public static PvaClient get()

Get the single instance of PvaClient. This connects to providers pva and ca.

Returns:

The interface to PvaClient.

destroy

public void destroy()

Destroy all cached channels.

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

channel

public PvaClientChannel channel(String channelName)

Get a cached channel or create and connect to a new channel. The provider is pva. The timeout is 5 seconds.

Parameters:

channelName - The channelName.

Returns:

The interface.

Throws:

RuntimeException - if connection fails.

channel

public PvaClientChannel channel(String channelName,
                                String providerName)

Get a cached channel or create and connect to a new channel. The timeout is 5 seconds.

Parameters:

channelName - The channelName.

providerName - The provider name.

Returns:

The interface.

Throws:

RuntimeException - if connection fails.

channel

public PvaClientChannel channel(String channelName,
                                String providerName,
                                double timeOut)

Get a cached channel or create and connect to a new channel.

Parameters:

channelName - The channelName.

providerName - The provider name.

timeOut - The number of seconds to wait for connection. 0.0 means forever.

Returns:

The interface.

Throws:

RuntimeException - if connection fails.

createChannel

public PvaClientChannel createChannel(String channelName)

Create an PvaClientChannel. The provider is pvAccess.

Parameters:

channelName - The channelName.

Returns:

The interface.

Throws:

RuntimeException - if connection fails.

createChannel

public PvaClientChannel createChannel(String channelName,
                                      String providerName)

Create an PvaClientChannel with the specified provider.

Parameters:

channelName - The channelName.

providerName - The provider.

Returns:

The interface or null if the provider does not exist.

Throws:

RuntimeException - if connection fails.

setRequester

public void setRequester(org.epics.pvdata.pv.Requester requester)

Set a requester. The default is for PvaClient to handle messages by printing to System.out.

Parameters:

requester - The requester.

clearRequester

public void clearRequester()

Clear the requester. PvaClientPVA will handle messages.

showCache

public String showCache()

Show the list of cached gets and puts.

Returns:

A String showing the cached channels.

cacheSize

public int cacheSize()

Get the number of cached gets and puts.

Returns:

The size.

setDebug

public static void setDebug(boolean value)

Should debug info be shown?

Parameters:

value - true or false

getDebug

public static boolean getDebug()

Is debug set?

Returns:

true or false