epics::pvaClient::PvaClientPutGet Class Reference

An easy to use alternative to ChannelPutGet. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientPutGet:

Collaboration diagram for epics::pvaClient::PvaClientPutGet:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientPutGet)
	~PvaClientPutGet ()
	Destructor. More...
void	setRequester (PvaClientPutGetRequesterPtr const &pvaClientPutGetRequester)
	Set a user callback. More...
void	connect ()
	Call issueConnect and then waitConnect. More...
void	issueConnect ()
	Issue the channelPutGet connection to the channel. More...
epics::pvData::Status	waitConnect ()
	Wait until the channelPutGet connection to the channel is complete. More...
void	putGet ()
	Call issuePutGet and then waitPutGet. More...
void	issuePutGet ()
	Issue a putGet and return immediately. More...
epics::pvData::Status	waitPutGet ()
	Wait until putGet completes. More...
void	getGet ()
	Call issueGet and then waitGetGet. An exception is thrown if get fails. More...
void	issueGetGet ()
	Issue a getGet and return immediately. More...
epics::pvData::Status	waitGetGet ()
	Wait until getGet completes. More...
void	getPut ()
	Call issuePut and then waitGetPut. More...
void	issueGetPut ()
	Issue a getPut and return immediately. More...
epics::pvData::Status	waitGetPut ()
	Wait until getPut completes. More...
PvaClientPutDataPtr	getPutData ()
	Get the put data. More...
PvaClientGetDataPtr	getGetData ()
	Get the get data. More...
PvaClientChannelPtr	getPvaClientChannel ()
	Get the PvaClientChannel;. More...

Static Public Member Functions
static PvaClientPutGetPtr	create (PvaClientPtr const &pvaClient, PvaClientChannelPtr const &pvaClientChannel, epics::pvData::PVStructurePtr const &pvRequest)
	Create a PvaClientPutGet. More...

Friends
class	ChannelPutGetRequesterImpl

Detailed Description

An easy to use alternative to ChannelPutGet.

Overview of PvaClientPutGet

Definition at line 1369 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientPutGet::~PvaClientPutGet

(

)

Destructor.

Definition at line 124 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout<< "PvaClientPutGet::~PvaClientPutGet"
           << " channelName " <<  pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
}

Member Function Documentation

void epics::pvaClient::PvaClientPutGet::connect

(

)

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions

runtime_error

if failure.

Definition at line 290 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::connect"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    issueConnect();
    Status status = waitConnect();
    if(status.isOK()) return;
    string message = string("channel ")
        + pvaClientChannel->getChannel()->getChannelName()
        + " PvaClientPutGet::connect "
        + status.getMessage();
    throw std::runtime_error(message);
}

PvaClientPutGetPtr epics::pvaClient::PvaClientPutGet::create ( PvaClientPtr const &  pvaClient, PvaClientChannelPtr const &  pvaClientChannel, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Create a PvaClientPutGet.

Parameters

pvaClient	Interface to PvaClient
pvaClientChannel	Interface to Channel
pvRequest	The request structure.

Returns

The interface to the PvaClientPutGet.

Definition at line 96 of file pvaClientPutGet.cpp.

{
    PvaClientPutGetPtr clientPutGet(new PvaClientPutGet(pvaClient,pvaClientChannel,pvRequest));
    clientPutGet->channelPutGetRequester = ChannelPutGetRequesterImplPtr(
        new ChannelPutGetRequesterImpl(clientPutGet,pvaClient));
    return clientPutGet;
}

void epics::pvaClient::PvaClientPutGet::getGet

(

)

Call issueGet and then waitGetGet. An exception is thrown if get fails.

Definition at line 406 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::getGet"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    issueGetGet();
    Status status = waitGetGet();
    if(status.isOK()) return;
    string message = string("channel ")
        + pvaClientChannel->getChannel()->getChannelName()
        + " PvaClientPut::getGet "
        + status.getMessage();
    throw std::runtime_error(message);
}

PvaClientGetDataPtr epics::pvaClient::PvaClientPutGet::getGetData

(

)

Get the get data.

Returns

The interface.

Definition at line 512 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
           cout<< "PvaClientPutGet::getGetData"
               << " channelName " << pvaClientChannel->getChannel()->getChannelName()
               << endl;
    }
    checkPutGetState();
    if(putGetState==putGetIdle){
       getGet();
       getPut();
    }
    return pvaClientGetData;
}

void epics::pvaClient::PvaClientPutGet::getPut

(

)

Call issuePut and then waitGetPut.

An exception is thrown if getPut fails.

Definition at line 459 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::getGetPut"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    issueGetPut();
    Status status = waitGetPut();
    if(status.isOK()) return;
    string message = string("channel ")
        + pvaClientChannel->getChannel()->getChannelName()
        + " PvaClientPut::getPut "
        + status.getMessage();
    throw std::runtime_error(message);
}

PvaClientPutDataPtr epics::pvaClient::PvaClientPutGet::getPutData

(

)

Get the put data.

Returns

The interface.

Definition at line 527 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
           cout<< "PvaClientPutGet::getPutData"
               << " channelName " << pvaClientChannel->getChannel()->getChannelName()
               << endl;
    }
    checkPutGetState();
    if(putGetState==putGetIdle){
       getGet();
       getPut();
    }
    return pvaClientPutData;
}

PvaClientChannelPtr epics::pvaClient::PvaClientPutGet::getPvaClientChannel

(

)

Get the PvaClientChannel;.

Returns

The interface.

Definition at line 553 of file pvaClientPutGet.cpp.

{
    return pvaClientChannel;
}

void epics::pvaClient::PvaClientPutGet::issueConnect

(

)

Issue the channelPutGet connection to the channel.

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

Definition at line 307 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::issueConnect"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(connectState!=connectIdle) {
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            + " pvaClientPutGet already connected ";
        throw std::runtime_error(message);
    }
    connectState = connectActive;
    channelPutGetConnectStatus = Status(Status::STATUSTYPE_ERROR, "connect active");
    channelPutGet = pvaClientChannel->getChannel()->createChannelPutGet(channelPutGetRequester,pvRequest);
}

void epics::pvaClient::PvaClientPutGet::issueGetGet

(

)

Issue a getGet and return immediately.

Definition at line 423 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::issueGetGet"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(connectState==connectIdle) connect();
    if(putGetState==putGetActive) {
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientPutGet::issueGetGet get or put aleady active ";
        throw std::runtime_error(message);
    }
    putGetState = putGetActive;
    channelPutGet->getGet();
}

void epics::pvaClient::PvaClientPutGet::issueGetPut

(

)

Issue a getPut and return immediately.

Definition at line 476 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::issueGetPut"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(connectState==connectIdle) connect();
    if(putGetState==putGetActive) {
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientPutGet::issueGetPut get or put aleady active ";
        throw std::runtime_error(message);
    }
    putGetState = putGetActive;
    channelPutGet->getPut();
}

void epics::pvaClient::PvaClientPutGet::issuePutGet

(

)

Issue a putGet and return immediately.

Definition at line 368 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::issuePutGet"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(connectState==connectIdle) connect();
    if(putGetState==putGetActive) {
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientPutGet::issuePutGet get or put aleady active ";
        throw std::runtime_error(message);
    }
    putGetState = putGetActive;
    channelPutGet->putGet(pvaClientPutData->getPVStructure(),pvaClientPutData->getChangedBitSet());
}

epics::pvaClient::PvaClientPutGet::POINTER_DEFINITIONS

(

PvaClientPutGet

)

void epics::pvaClient::PvaClientPutGet::putGet

(

)

Call issuePutGet and then waitPutGet.

An exception is thrown if putGet fails.

Definition at line 351 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::putGet"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    issuePutGet();
    Status status = waitPutGet();
    if(status.isOK()) return;
    string message = string("channel ")
        + pvaClientChannel->getChannel()->getChannelName()
        + " PvaClientPut::putGet "
        + status.getMessage();
    throw std::runtime_error(message);
}

void epics::pvaClient::PvaClientPutGet::setRequester

(

PvaClientPutGetRequesterPtr const &

pvaClientPutGetRequester

)

Set a user callback.

Parameters

pvaClientPutGetRequester

The requester which must be implemented by the caller.

Definition at line 542 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::setRequester"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    this->pvaClientPutGetRequester = pvaClientPutGetRequester;
}

Status epics::pvaClient::PvaClientPutGet::waitConnect

(

)

Wait until the channelPutGet connection to the channel is complete.

Returns

status;

Definition at line 325 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::waitConnect"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    {
         Lock xx(mutex);
         if(connectState==connected) {
             if(!channelPutGetConnectStatus.isOK()) connectState = connectIdle;
             return channelPutGetConnectStatus;
        }
        if(connectState!=connectActive)  {
            string message = string("channel ")
                + pvaClientChannel->getChannel()->getChannelName()
                + " PvaClientPutGet::waitConnect illegal connect state ";
            throw std::runtime_error(message);
        }
    }
    waitForConnect.wait();
    if(!channelPutGetConnectStatus.isOK()) connectState = connectIdle;
    return channelPutGetConnectStatus;
}

Status epics::pvaClient::PvaClientPutGet::waitGetGet

(

)

Wait until getGet completes.

If failure getStatus can be called to get reason.

Returns

status

Definition at line 441 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::waitGetGet"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(putGetState==putGetComplete) return channelPutGetStatus;
    if(putGetState!=putGetActive){
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientPutGet::waitGetGet get or put aleady active ";
        throw std::runtime_error(message);
    }
    waitForPutGet.wait();
    return channelPutGetStatus;
}

Status epics::pvaClient::PvaClientPutGet::waitGetPut

(

)

Wait until getPut completes.

Returns

status

Definition at line 494 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::waitGetPut"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(putGetState==putGetComplete) return channelPutGetStatus;
    if(putGetState!=putGetActive){
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientPutGet::waitGetPut get or put aleady active ";
        throw std::runtime_error(message);
    }
    waitForPutGet.wait();
    return channelPutGetStatus;
}

Status epics::pvaClient::PvaClientPutGet::waitPutGet

(

)

Wait until putGet completes.

If failure getStatus can be called to get reason.

Returns

status

Definition at line 387 of file pvaClientPutGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPutGet::waitPutGet"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(putGetState==putGetComplete) return channelPutGetStatus;
    if(putGetState!=putGetActive){
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientPutGet::waitPutGet get or put aleady active ";
        throw std::runtime_error(message);
    }
    waitForPutGet.wait();
    if(channelPutGetStatus.isOK()) pvaClientPutData->getChangedBitSet()->clear();
    return channelPutGetStatus;
}

Friends And Related Function Documentation

friend class ChannelPutGetRequesterImpl

friend

Definition at line 1511 of file pvaClient.h.

---

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

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