epics::pvAccess::RPCClient Class Reference

#include "rpcClient.h"

Classes
struct	RPCRequester

Public Member Functions
	POINTER_DEFINITIONS (RPCClient)
	RPCClient (const std::string &serviceName, epics::pvData::PVStructure::shared_pointer const &pvRequest, const ChannelProvider::shared_pointer &provider=ChannelProvider::shared_pointer(), const std::string &address=std::string())
	~RPCClient ()
void	destroy ()
bool	connect (double timeout=RPCCLIENT_DEFAULT_TIMEOUT)
void	issueConnect ()
bool	waitConnect (double timeout=RPCCLIENT_DEFAULT_TIMEOUT)
epics::pvData::PVStructure::shared_pointer	request (epics::pvData::PVStructure::shared_pointer const &pvArgument, double timeout=RPCCLIENT_DEFAULT_TIMEOUT, bool lastRequest=false)
void	issueRequest (epics::pvData::PVStructure::shared_pointer const &pvArgument, bool lastRequest=false)
epics::pvData::PVStructure::shared_pointer	waitResponse (double timeout=RPCCLIENT_DEFAULT_TIMEOUT)

Static Public Member Functions
static shared_pointer	create (const std::string &serviceName, epics::pvData::PVStructure::shared_pointer const &pvRequest=epics::pvData::PVStructure::shared_pointer())

Detailed Description

RPCClient is an interface class that is used by a service client.

Definition at line 39 of file rpcClient.h.

Constructor & Destructor Documentation

epics::pvAccess::RPCClient::RPCClient	(	const std::string &	serviceName,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest,
		const ChannelProvider::shared_pointer &	provider = ChannelProvider::shared_pointer(),
		const std::string &	address = std::string()
	)

epics::pvAccess::RPCClient::~RPCClient ( )

inline

Definition at line 59 of file rpcClient.h.

{destroy();}

Member Function Documentation

bool epics::pvAccess::RPCClient::connect

(

double

timeout = RPCCLIENT_DEFAULT_TIMEOUT

)

Connect to the server. The method blocks until the connection is made or a timeout occurs. It is the same as calling issueConnect and then waitConnect.

Parameters

timeout

Timeout in seconds to wait, 0 means forever.

Returns

(false,true) If (not connected, is connected). If false then connect must be reissued.

Definition at line 159 of file rpcClient.cpp.

{
    issueConnect();
    return waitConnect(timeout);
}

RPCClient::shared_pointer epics::pvAccess::RPCClient::create ( const std::string &  serviceName, epics::pvData::PVStructure::shared_pointer const &  pvRequest = epics::pvData::PVStructure::shared_pointer()  )

static

Create a RPCClient.

Parameters

serviceName	the service name
pvRequest	the pvRequest for the ChannelRPC

Returns

the RPCClient interface

Definition at line 266 of file rpcClient.cpp.

{
    return RPCClient::shared_pointer(new RPCClient(serviceName, pvRequest));
}

void epics::pvAccess::RPCClient::destroy

(

)

Destroy this instance (i.e. release resources).

Definition at line 145 of file rpcClient.cpp.

{
    if (m_channel)
    {
        m_channel->destroy();
        m_channel.reset();
    }
    if (m_rpc)
    {
        m_rpc->destroy();
        m_rpc.reset();
    }
}

void epics::pvAccess::RPCClient::issueConnect

(

)

Issue a connect request and return immediately. waitConnect must be called to complete the request.

Definition at line 165 of file rpcClient.cpp.

{
}

void epics::pvAccess::RPCClient::issueRequest	(	epics::pvData::PVStructure::shared_pointer const &	pvArgument,
		bool	lastRequest = false
	)

Issue a channelRPC request and return immediately. waitRequest must be called to complete the request.

Parameters

pvAgument	The argument to pass to the server.
lastRequest	If true an automatic destroy is made.

Exceptions

std::runtime_error

excption thrown on any runtime error condition (e.g. no connection made).

Definition at line 201 of file rpcClient.cpp.

{
    {
        pvd::Lock L(m_rpc_requester->mutex);
        TRACE("conn_status="<<m_rpc_requester->conn_status
            <<" resp_status="<<m_rpc_requester->resp_status
            <<" args:\n"<<pvArgument);
        if(m_rpc_requester->inprogress)
            throw std::logic_error("Request already in progress");
        m_rpc_requester->inprogress = true;
        m_rpc_requester->resp_status = pvd::Status::error("No Data");
        if(!m_rpc_requester->conn_status.isSuccess()) {
            TRACE("defer");
            m_rpc_requester->last = lastRequest;
            m_rpc_requester->next_args = pvArgument;
            return;
        }
        TRACE("request args: "<<pvArgument);
    }
    if(lastRequest)
        m_rpc->lastRequest();
    m_rpc->request(pvArgument);
}

epics::pvAccess::RPCClient::POINTER_DEFINITIONS

(

RPCClient

)

pvd::PVStructure::shared_pointer epics::pvAccess::RPCClient::request	(	epics::pvData::PVStructure::shared_pointer const &	pvArgument,
		double	timeout = RPCCLIENT_DEFAULT_TIMEOUT,
		bool	lastRequest = false
	)

Sends a request and wait for the response or until timeout occurs. This method will also wait for client to connect, if necessary.

Parameters

pvArgument	the argument for the rpc
timeout	the time in seconds to wait for the response, 0 means forever.
lastRequest	If true an automatic destroy is made.

Returns

request response.

Exceptions

RPCRequestException

exception thrown on error or timeout.

Definition at line 187 of file rpcClient.cpp.

{
    if (connect(timeout))
    {
        issueRequest(pvArgument, lastRequest);
        return waitResponse(timeout);       // TODO reduce timeout for a time spent on connect
    }
    else
        throw epics::pvAccess::RPCRequestException(pvd::Status::STATUSTYPE_ERROR, "connection timeout");
}

bool epics::pvAccess::RPCClient::waitConnect

(

double

timeout = RPCCLIENT_DEFAULT_TIMEOUT

)

Wait for the connect request to complete.

Parameters

timeout

timeout in seconds to wait, 0 means forever.

Returns

(false,true) If (not connected, is connected). If false then connect must be reissued.

Definition at line 169 of file rpcClient.cpp.

{
    pvd::Lock L(m_rpc_requester->mutex);
    TRACE("timeout="<<timeout);
    while(!m_rpc_requester->conn_status.isSuccess()) {
        L.unlock();
        if(!m_rpc_requester->event.wait(timeout)) {
            TRACE("TIMEOUT");
            return false;
        }
        L.lock();
    }
    TRACE("Connected");
    return true;
}

pvd::PVStructure::shared_pointer epics::pvAccess::RPCClient::waitResponse

(

double

timeout = RPCCLIENT_DEFAULT_TIMEOUT

)

Wait for the request to complete.

Parameters

timeout

the time in seconds to wait for the reponse.

Returns

request response.

Exceptions

RPCRequestException

exception thrown on error or timeout.

Definition at line 227 of file rpcClient.cpp.

{
    pvd::Lock L(m_rpc_requester->mutex);
    TRACE("timeout="<<timeout);

    while(m_rpc_requester->inprogress)
    {
        L.unlock();
        if(!m_rpc_requester->event.wait(timeout)) {
            TRACE("TIMEOUT");
            throw RPCRequestException(pvd::Status::STATUSTYPE_ERROR, "RPC timeout");
        }
        L.lock();
    }
    TRACE("Complete: conn_status="<<m_rpc_requester->conn_status
                 <<" resp_status="<<m_rpc_requester->resp_status
                 <<" data:\n"<<m_rpc_requester->last_data);

    if(!m_rpc_requester->conn_status.isSuccess())
        throw RPCRequestException(pvd::Status::STATUSTYPE_ERROR, m_rpc_requester->conn_status.getMessage());

    if(!m_rpc_requester->resp_status.isSuccess())
        throw RPCRequestException(pvd::Status::STATUSTYPE_ERROR, m_rpc_requester->resp_status.getMessage());

    // consume last_data so that we can't possibly return it twice
    pvd::PVStructure::shared_pointer data;
    data.swap(m_rpc_requester->last_data);

    if(!data)
        throw std::logic_error("No request in progress");

    // copy it so that the caller need not worry about whether it will overwritten
    // when the next request is issued
    pvd::PVStructure::shared_pointer ret(pvd::getPVDataCreate()->createPVStructure(data->getStructure()));
    ret->copyUnchecked(*data);

    return ret;
}

---

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

• modules/pvAccess/src/rpcClient/pv/rpcClient.h
• modules/pvAccess/src/rpcClient/rpcClient.cpp