epics::pvaClient::PvaClient Class Reference

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

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClient:

Collaboration diagram for epics::pvaClient::PvaClient:

Public Member Functions
	POINTER_DEFINITIONS (PvaClient)
	~PvaClient ()
	Destructor. More...
std::string	getRequesterName ()
void	message (std::string const &message, epics::pvData::MessageType messageType)
	A new message. More...
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. More...
PvaClientChannelPtr	createChannel (std::string const &channelName, std::string const &providerName="pva")
	Create an PvaClientChannel with the specified provider. More...
void	setRequester (epics::pvData::RequesterPtr const &requester)
	Set a requester. More...
void	clearRequester ()
	Clear the requester. PvaClient will handle messages. More...
void	showCache ()
	Show the list of cached channels. More...
size_t	cacheSize ()
	Get the number of cached channels. More...

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

Detailed Description

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

Overview of PvaClient

Definition at line 106 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClient::~PvaClient

(

)

Destructor.

Definition at line 148 of file pvaClient.cpp.

                      {
    if(getDebug()) {
        cout<< "PvaClient::~PvaClient()\n"
            << "pvaChannel cache:\n";
        showCache();
    }
    if(pvaStarted){
        if(getDebug()) cout<< "calling ClientFactory::stop()\n";
        ClientFactory::stop();
        if(getDebug()) cout<< "after calling ClientFactory::stop()\n";
    }
    if(caStarted) {
        if(getDebug()) cout<< "calling CAClientFactory::stop()\n";
        CAClientFactory::stop();
        if(getDebug()) cout<< "after calling CAClientFactory::stop()\n";
    }
channelRegistry.reset();
}

Member Function Documentation

size_t epics::pvaClient::PvaClient::cacheSize

(

)

Get the number of cached channels.

Definition at line 228 of file pvaClient.cpp.

{
    return pvaClientChannelCache->cacheSize();
}

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.

{
    PvaClientChannelPtr pvaClientChannel =
        pvaClientChannelCache->getChannel(channelName,providerName);
    if(pvaClientChannel) return pvaClientChannel;
    pvaClientChannel = createChannel(channelName,providerName);
    pvaClientChannel->connect(timeOut);
    pvaClientChannelCache->addChannel(pvaClientChannel);
    return pvaClientChannel;
}

void epics::pvaClient::PvaClient::clearRequester

(

)

Clear the requester. PvaClient will handle messages.

Definition at line 213 of file pvaClient.cpp.

{
    requester.reset();
}

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

static

Get the requester name.

Returns

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

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.

{return get();}

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.

Exceptions

runtime_error

if connection fails.

Definition at line 203 of file pvaClient.cpp.

{
     return PvaClientChannel::create(shared_from_this(),channelName,providerName);
}

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.

{
    static  PvaClientPtr master;
    static Mutex mutex;
    Lock xx(mutex);
    if(!master) {
        master = PvaClientPtr(new PvaClient(providerNames));
    }
    return master;
}

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

static

Is debug set?

Returns

true or false

Definition at line 97 of file pvaClient.cpp.

{
    return debug;
}

string epics::pvaClient::PvaClient::getRequesterName

(

)

Definition at line 167 of file pvaClient.cpp.

{
    static string name("pvaClient");
    RequesterPtr req = requester.lock();
    if(req) {
         return req->getRequesterName();
    }
    return name;
}

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.

{
    RequesterPtr req = requester.lock();
    if(req) {
         req->message(message,messageType);
         return;
    }
    cout << getMessageTypeName(messageType) << " " << message << endl;
}

epics::pvaClient::PvaClient::POINTER_DEFINITIONS

(

PvaClient

)

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.

{
    debug = value;
}

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.

{
    this->requester = requester;
}

void epics::pvaClient::PvaClient::showCache

(

)

Show the list of cached channels.

Definition at line 218 of file pvaClient.cpp.

{
    if(pvaClientChannelCache->cacheSize()>=1) {
        pvaClientChannelCache->showCache();
    } else {
         cout << "pvaClientChannelCache is empty\n";
    }
}

---

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

• modules/pvaClient/src/pv/pvaClient.h
• modules/pvaClient/src/pvaClient.cpp