epics::pvaClient::PvaClientRPC Class Reference

An easy to use alternative to RPC. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientRPC:

Collaboration diagram for epics::pvaClient::PvaClientRPC:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientRPC)
	~PvaClientRPC ()
	Destructor. More...
void	setResponseTimeout (double responseTimeout)
	Set a timeout for a request. More...
double	getResponseTimeout ()
	Get the responseTimeout. More...
void	connect ()
	Call issueConnect and then waitConnect. More...
void	issueConnect ()
	Issue the channelRPC connection to the channel. More...
epics::pvData::Status	waitConnect ()
	Wait until the channelRPC connection to the channel is complete. More...
epics::pvData::PVStructure::shared_pointer	request (epics::pvData::PVStructure::shared_pointer const &pvArgument)
	Issue a request and wait for response. More...
void	request (epics::pvData::PVStructure::shared_pointer const &pvArgument, PvaClientRPCRequesterPtr const &pvaClientRPCRequester)
	issue a request and return immediately. More...

Static Public Member Functions
static PvaClientRPCPtr	create (PvaClientPtr const &pvaClient, epics::pvAccess::Channel::shared_pointer const &channel)
	Create a PvaClientRPC. More...
static PvaClientRPCPtr	create (PvaClientPtr const &pvaClient, epics::pvAccess::Channel::shared_pointer const &channel, epics::pvData::PVStructurePtr const &pvRequest)
	Create a PvaClientRPC. More...

Friends
class	RPCRequesterImpl

Detailed Description

An easy to use alternative to RPC.

Overview of PvaClientRPC

Definition at line 1736 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientRPC::~PvaClientRPC

(

)

Destructor.

Definition at line 112 of file pvaClientRPC.cpp.

{
    if(PvaClient::getDebug()) {
        string channelName("disconnected");
        Channel::shared_pointer chan(channel.lock());
        if(chan) channelName = chan->getChannelName();
        cout<< "PvaClientRPC::~PvaClientRPC"
           << " channelName " << channelName
           << endl;
    }
}

Member Function Documentation

void epics::pvaClient::PvaClientRPC::connect

(

)

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Definition at line 216 of file pvaClientRPC.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientRPC::connect\n";
    issueConnect();
    Status status = waitConnect();
    if(status.isOK()) return;
    Channel::shared_pointer chan(channel.lock());
    string channelName("disconnected");
    if(chan) channelName = chan->getChannelName();
    string message = string("channel ")
        + channelName
        + " PvaClientRPC::connect "
        + status.getMessage();
    throw RPCRequestException(Status::STATUSTYPE_ERROR,message);
}

static PvaClientRPCPtr epics::pvaClient::PvaClientRPC::create ( PvaClientPtr const &  pvaClient, epics::pvAccess::Channel::shared_pointer const &  channel  )

static

Create a PvaClientRPC.

Parameters

&pvaClient	Interface to PvaClient
channel	Interface to Channel

Returns

The interface to the PvaClientRPC.

static PvaClientRPCPtr epics::pvaClient::PvaClientRPC::create ( PvaClientPtr const &  pvaClient, epics::pvAccess::Channel::shared_pointer const &  channel, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Create a PvaClientRPC.

Parameters

&pvaClient	Interface to PvaClient
channel	Interface to Channel
pvRequest	The request structure.

Returns

The interface to the PvaClientRPC.

double epics::pvaClient::PvaClientRPC::getResponseTimeout ( )

inline

Get the responseTimeout.

Returns

The value.

Definition at line 1775 of file pvaClient.h.

    {
        return responseTimeout;
    }

void epics::pvaClient::PvaClientRPC::issueConnect

(

)

Issue the channelRPC connection to the channel.

This can only be called once. An exception is thrown if connect fails.

Exceptions

runtime_error

if failure.

Definition at line 232 of file pvaClientRPC.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientRPC::issueConnect\n";
    Channel::shared_pointer chan(channel.lock());
    if(connectState!=connectIdle) {
        string channelName("disconnected");
        if(chan) channelName = chan->getChannelName();
        string message = string("channel ")
            + channelName
            + " pvaClientRPC already connected ";
        throw std::runtime_error(message);
    }
    if(chan) {
        connectState = connectActive;
        channelRPC = chan->createChannelRPC(rpcRequester,pvRequest);
        return;
    }
    throw std::runtime_error("PvaClientRPC::issueConnect() but channel disconnected");
}

epics::pvaClient::PvaClientRPC::POINTER_DEFINITIONS

(

PvaClientRPC

)

epics::pvData::PVStructure::shared_pointer epics::pvaClient::PvaClientRPC::request

(

epics::pvData::PVStructure::shared_pointer const &

pvArgument

)

Issue a request and wait for response.

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 data to send to the service.

Returns

The result

Exceptions

runtime_error

if failure.

void epics::pvaClient::PvaClientRPC::request	(	epics::pvData::PVStructure::shared_pointer const &	pvArgument,
		PvaClientRPCRequesterPtr const &	pvaClientRPCRequester
	)

issue a request and return immediately.

Parameters

pvArgument	The data to send to the service.
pvaClientRPCRequester	The requester that is called with the result.

Exceptions

runtime_error

if failure.

void epics::pvaClient::PvaClientRPC::setResponseTimeout ( double  responseTimeout )

inline

Set a timeout for a request.

Parameters

responseTimeout

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

Definition at line 1767 of file pvaClient.h.

    {
        this->responseTimeout = responseTimeout;
    }

Status epics::pvaClient::PvaClientRPC::waitConnect

(

)

Wait until the channelRPC connection to the channel is complete.

Returns

status;

Definition at line 252 of file pvaClientRPC.cpp.

{
    if(PvaClient::getDebug()) cout << "PvaClientRPC::waitConnect\n";
    if(connectState==connected) {
         if(!connectStatus.isOK()) connectState = connectIdle;
         return connectStatus;
    }
    if(connectState!=connectActive) {
        Channel::shared_pointer chan(channel.lock());
        string channelName("disconnected");
        if(chan) channelName = chan->getChannelName();
        string message = string("channel ")
            + channelName
            + " PvaClientRPC::waitConnect illegal connect state ";
        throw std::runtime_error(message);
    }
    if(PvaClient::getDebug()) {
        cout << "PvaClientRPC::waitConnect calling waitForConnect.wait\n";
    }
    waitForConnect.wait();
    connectState = connectStatus.isOK() ? connected : connectIdle;
    if(PvaClient::getDebug()) {
        cout << "PvaClientRPC::waitConnect"
             << " connectStatus " << (connectStatus.isOK() ? "connected" : "not connected");
    }
    return connectStatus;
}

Friends And Related Function Documentation

friend class RPCRequesterImpl

friend

Definition at line 1851 of file pvaClient.h.

---

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

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