epics::pvaClient::PvaClient Class Reference

pvaClient is a synchronous wrapper for the pvAccess API, which is a callback based API. More...

#include <pv/pvaClient.h>

Inheritance diagram for epics::pvaClient::PvaClient:

Public Member Functions
	POINTER_DEFINITIONS (PvaClient)
	~PvaClient ()
	Destructor.
void	message (std::string const &message, epics::pvData::MessageType messageType)
	A new message.
PvaClientChannelPtr	channel (std::string const &channelName, std::string const &providerName="pva", double timeOut=5.0)
	Get a cached channel or create and connect to a new channel.
PvaClientChannelPtr	createChannel (std::string const &channelName, std::string const &providerName="pva")
	Create an PvaClientChannel with the specified provider.
void	setRequester (epics::pvData::RequesterPtr const &requester)
	Set a requester.
std::string	getRequesterName ()
	Get the requester name.
void	clearRequester ()
	Clear the requester. PvaClient will handle messages.
void	showCache ()
	Show the list of cached channels.
size_t	cacheSize ()
	Get the number of cached channels.

Static Public Member Functions
static PvaClientPtr	get (std::string const &providerNames="pva ca")
	Get the single instance of PvaClient.
static PvaClientPtr	create () EPICS_DEPRECATED
	Create an instance of PvaClient with providerName "pva ca".
static void	setDebug (bool value)
	Should debug info be shown?
static bool	getDebug ()
	Is debug set?

Detailed Description

pvaClient is a synchronous wrapper for the pvAccess API, which is a callback based API.

Definition at line 101 of file pvaClient.h.

Constructor & Destructor Documentation

~PvaClient()

epics::pvaClient::PvaClient::~PvaClient

(

)

Destructor.

Definition at line 148 of file pvaClient.cpp.

References getDebug(), and showCache().

Member Function Documentation

cacheSize()

size_t epics::pvaClient::PvaClient::cacheSize

(

)

Get the number of cached channels.

Definition at line 228 of file pvaClient.cpp.

channel()

PvaClientChannelPtr epics::pvaClient::PvaClient::channel	(	std::string const &	channelName,
		std::string const &	providerName = "pva",
		double	timeOut = 5.0 )

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

Parameters

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

Returns

The interface.

Exceptions

runtime_error

if connection fails.

Definition at line 189 of file pvaClient.cpp.

References createChannel().

clearRequester()

void epics::pvaClient::PvaClient::clearRequester

(

)

Clear the requester. PvaClient will handle messages.

Definition at line 213 of file pvaClient.cpp.

create()

PvaClientPtr epics::pvaClient::PvaClient::create ( )

static

Create an instance of PvaClient with providerName "pva ca".

Returns

shared pointer to the single instance

Deprecated

This method will go away in future versions. Use get instead.

Definition at line 113 of file pvaClient.cpp.

References get().

createChannel()

PvaClientChannelPtr epics::pvaClient::PvaClient::createChannel	(	std::string const &	channelName,
		std::string const &	providerName = "pva" )

Create an PvaClientChannel with the specified provider.

Parameters

channelName	The channelName.
providerName	The provider.

Returns

The interface.

Definition at line 203 of file pvaClient.cpp.

Referenced by channel().

get()

PvaClientPtr epics::pvaClient::PvaClient::get ( std::string const & providerNames = "pva ca" )

static

Get the single instance of PvaClient.

Parameters

providerNames

Space separated list of provider names.

Returns

shared pointer to the single instance.

Definition at line 102 of file pvaClient.cpp.

Referenced by create().

getDebug()

bool epics::pvaClient::PvaClient::getDebug ( )

static

Is debug set?

Returns

true or false

Definition at line 97 of file pvaClient.cpp.

Referenced by epics::pvaClient::PvaClientChannel::channelCreated(), epics::pvaClient::PvaClientChannel::channelStateChange(), epics::pvaClient::PvaClientMonitor::channelStateChange(), epics::pvaClient::PvaClientData::checkValue(), epics::pvaClient::PvaClientChannel::connect(), epics::pvaClient::PvaClientGet::connect(), epics::pvaClient::PvaClientMonitor::connect(), epics::pvaClient::PvaClientProcess::connect(), epics::pvaClient::PvaClientPut::connect(), epics::pvaClient::PvaClientPutGet::connect(), epics::pvaClient::PvaClientRPC::connect(), epics::pvaClient::PvaClientData::create(), epics::pvaClient::PvaClientGet::create(), epics::pvaClient::PvaClientGetData::create(), epics::pvaClient::PvaClientMonitor::create(), epics::pvaClient::PvaClientProcess::create(), epics::pvaClient::PvaClientPutData::create(), epics::pvaClient::PvaClientMonitor::event(), epics::pvaClient::PvaClientGet::get(), epics::pvaClient::PvaClientPut::get(), epics::pvaClient::PvaClientData::getAlarm(), epics::pvaClient::PvaClientData::getArrayValue(), epics::pvaClient::PvaClientGet::getData(), epics::pvaClient::PvaClientMonitor::getData(), epics::pvaClient::PvaClientPut::getData(), epics::pvaClient::PvaClientData::getDouble(), epics::pvaClient::PvaClientData::getDoubleArray(), epics::pvaClient::PvaClientPutGet::getGet(), epics::pvaClient::PvaClientPutGet::getGetData(), epics::pvaClient::PvaClientPutGet::getPut(), epics::pvaClient::PvaClientPutGet::getPutData(), epics::pvaClient::PvaClientData::getScalarArrayValue(), epics::pvaClient::PvaClientData::getScalarValue(), epics::pvaClient::PvaClientData::getSinglePVField(), epics::pvaClient::PvaClientData::getString(), epics::pvaClient::PvaClientData::getStringArray(), epics::pvaClient::PvaClientData::getTimeStamp(), epics::pvaClient::PvaClientData::getValue(), epics::pvaClient::PvaClientData::hasValue(), epics::pvaClient::PvaClientChannel::issueConnect(), epics::pvaClient::PvaClientGet::issueConnect(), epics::pvaClient::PvaClientMonitor::issueConnect(), epics::pvaClient::PvaClientProcess::issueConnect(), epics::pvaClient::PvaClientPut::issueConnect(), epics::pvaClient::PvaClientPutGet::issueConnect(), epics::pvaClient::PvaClientRPC::issueConnect(), epics::pvaClient::PvaClientGet::issueGet(), epics::pvaClient::PvaClientPut::issueGet(), epics::pvaClient::PvaClientPutGet::issueGetGet(), epics::pvaClient::PvaClientPutGet::issueGetPut(), epics::pvaClient::PvaClientProcess::issueProcess(), epics::pvaClient::PvaClientPut::issuePut(), epics::pvaClient::PvaClientPutGet::issuePutGet(), epics::pvaClient::PvaClientData::isValueScalar(), epics::pvaClient::PvaClientData::isValueScalarArray(), epics::pvaClient::PvaClientMonitor::poll(), epics::pvaClient::PvaClientProcess::process(), epics::pvaClient::PvaClientPut::put(), epics::pvaClient::PvaClientPutData::putDouble(), epics::pvaClient::PvaClientPutData::putDoubleArray(), epics::pvaClient::PvaClientPutGet::putGet(), epics::pvaClient::PvaClientPutData::putString(), epics::pvaClient::PvaClientMonitor::releaseEvent(), epics::pvaClient::PvaClientData::setData(), epics::pvaClient::PvaClientGet::setRequester(), epics::pvaClient::PvaClientMonitor::setRequester(), epics::pvaClient::PvaClientProcess::setRequester(), epics::pvaClient::PvaClientPut::setRequester(), epics::pvaClient::PvaClientPutGet::setRequester(), epics::pvaClient::PvaClientMonitor::start(), epics::pvaClient::PvaClientMonitor::start(), epics::pvaClient::PvaClientMonitor::stop(), epics::pvaClient::PvaClientChannel::waitConnect(), epics::pvaClient::PvaClientGet::waitConnect(), epics::pvaClient::PvaClientMonitor::waitConnect(), epics::pvaClient::PvaClientProcess::waitConnect(), epics::pvaClient::PvaClientPut::waitConnect(), epics::pvaClient::PvaClientPutGet::waitConnect(), epics::pvaClient::PvaClientRPC::waitConnect(), epics::pvaClient::PvaClientMonitor::waitEvent(), epics::pvaClient::PvaClientGet::waitGet(), epics::pvaClient::PvaClientPut::waitGet(), epics::pvaClient::PvaClientPutGet::waitGetGet(), epics::pvaClient::PvaClientPutGet::waitGetPut(), epics::pvaClient::PvaClientProcess::waitProcess(), epics::pvaClient::PvaClientPut::waitPut(), epics::pvaClient::PvaClientPutGet::waitPutGet(), ~PvaClient(), epics::pvaClient::PvaClientChannel::~PvaClientChannel(), epics::pvaClient::PvaClientGet::~PvaClientGet(), epics::pvaClient::PvaClientMonitor::~PvaClientMonitor(), epics::pvaClient::PvaClientMultiChannel::~PvaClientMultiChannel(), epics::pvaClient::PvaClientMultiGetDouble::~PvaClientMultiGetDouble(), epics::pvaClient::PvaClientMultiMonitorDouble::~PvaClientMultiMonitorDouble(), epics::pvaClient::PvaClientMultiPutDouble::~PvaClientMultiPutDouble(), epics::pvaClient::PvaClientNTMultiData::~PvaClientNTMultiData(), epics::pvaClient::PvaClientNTMultiGet::~PvaClientNTMultiGet(), epics::pvaClient::PvaClientNTMultiMonitor::~PvaClientNTMultiMonitor(), epics::pvaClient::PvaClientNTMultiPut::~PvaClientNTMultiPut(), epics::pvaClient::PvaClientProcess::~PvaClientProcess(), epics::pvaClient::PvaClientPut::~PvaClientPut(), epics::pvaClient::PvaClientPutGet::~PvaClientPutGet(), and epics::pvaClient::PvaClientRPC::~PvaClientRPC().

getRequesterName()

string epics::pvaClient::PvaClient::getRequesterName

(

)

Get the requester name.

If client calls setRequester then the client supplies the name. Otherwise the name is pvaClient.

Returns

The name.

Definition at line 167 of file pvaClient.cpp.

message()

void epics::pvaClient::PvaClient::message	(	std::string const &	message,
		epics::pvData::MessageType	messageType )

A new message.

If a requester is set then it is called otherwise message is displayed on standard out.

Parameters

message	The message.
messageType	The type.

Definition at line 177 of file pvaClient.cpp.

References message().

Referenced by message().

POINTER_DEFINITIONS()

epics::pvaClient::PvaClient::POINTER_DEFINITIONS

(

PvaClient

)

setDebug()

void epics::pvaClient::PvaClient::setDebug ( bool value )

static

Should debug info be shown?

Parameters

value

true or false

Definition at line 92 of file pvaClient.cpp.

setRequester()

void epics::pvaClient::PvaClient::setRequester

(

epics::pvData::RequesterPtr const &

requester

)

Set a requester.

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

Parameters

requester

The requester.

Definition at line 208 of file pvaClient.cpp.

showCache()

void epics::pvaClient::PvaClient::showCache

(

)

Show the list of cached channels.

Definition at line 218 of file pvaClient.cpp.

Referenced by ~PvaClient().

---

The documentation for this class was generated from the following files:

• pv/pvaClient.h
• pvaClient.cpp