epics::pvaClient::PvaClientPut Class Reference

An easy to use alternative to ChannelPut. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientPut:

Collaboration diagram for epics::pvaClient::PvaClientPut:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientPut)
	~PvaClientPut ()
	Destructor. More...
void	setRequester (PvaClientPutRequesterPtr const &pvaClientPutRequester)
	Set a user callback. More...
void	connect ()
	Call issueConnect and then waitConnect. More...
void	issueConnect ()
	Issue the channelPut connection to the channel. More...
epics::pvData::Status	waitConnect ()
	Wait until the channelPut connection to the channel is complete. More...
void	get ()
	Call issueGet and then waitGet. More...
void	issueGet ()
	Issue a get and return immediately. More...
epics::pvData::Status	waitGet ()
	Wait until get completes. More...
void	put ()
	Call issuePut and then waitPut. An exception is thrown if get fails. More...
void	issuePut ()
	Issue a put and return immediately. More...
epics::pvData::Status	waitPut ()
	Wait until put completes. More...
PvaClientPutDataPtr	getData ()
	Get the data/. More...
PvaClientChannelPtr	getPvaClientChannel ()
	Get the PvaClientChannel;. More...

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

Friends
class	ChannelPutRequesterImpl

Detailed Description

An easy to use alternative to ChannelPut.

Overview of PvaClientPut

Definition at line 1191 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientPut::~PvaClientPut

(

)

Destructor.

Definition at line 111 of file pvaClientPut.cpp.

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

Member Function Documentation

void epics::pvaClient::PvaClientPut::connect

(

)

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions

runtime_error

if failure.

Definition at line 242 of file pvaClientPut.cpp.

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

PvaClientPutPtr epics::pvaClient::PvaClientPut::create ( PvaClientPtr const &  pvaClient, PvaClientChannelPtr const &  pvaClientChannel, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Create a PvaClientPut.

Parameters

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

Returns

The interface to the PvaClientPut.

Definition at line 82 of file pvaClientPut.cpp.

{
    PvaClientPutPtr clientPut(new PvaClientPut(pvaClient,pvaClientChannel,pvRequest));
    clientPut->channelPutRequester = ChannelPutRequesterImplPtr(
        new ChannelPutRequesterImpl(clientPut,pvaClient));
    return clientPut;
}

void epics::pvaClient::PvaClientPut::get

(

)

Call issueGet and then waitGet.

An exception is thrown if get fails.

Exceptions

runtime_error

if failure.

Definition at line 301 of file pvaClientPut.cpp.

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

PvaClientPutDataPtr epics::pvaClient::PvaClientPut::getData

(

)

Get the data/.

Returns

The interface.

Definition at line 416 of file pvaClientPut.cpp.

{
    if(PvaClient::getDebug()) {
           cout<< "PvaClientPut::getData"
               << " channelName " << pvaClientChannel->getChannel()->getChannelName()
               << endl;
    }
    checkConnectState();
    if(putState==putIdle) get();
    return pvaClientData;
}

PvaClientChannelPtr epics::pvaClient::PvaClientPut::getPvaClientChannel

(

)

Get the PvaClientChannel;.

Returns

The interface.

Definition at line 438 of file pvaClientPut.cpp.

{
    return pvaClientChannel;
}

void epics::pvaClient::PvaClientPut::issueConnect

(

)

Issue the channelPut connection to the channel.

This can only be called once.

Definition at line 259 of file pvaClientPut.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPut::issueConnect"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(connectState!=connectIdle) {
        string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
            + " pvaClientPut already connected ";
        throw std::runtime_error(message);
    }
    connectState = connectActive;
    channelPutConnectStatus = Status(Status::STATUSTYPE_ERROR, "connect active");
    channelPut = pvaClientChannel->getChannel()->createChannelPut(channelPutRequester,pvRequest);

}

void epics::pvaClient::PvaClientPut::issueGet

(

)

Issue a get and return immediately.

Definition at line 318 of file pvaClientPut.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPut::issueGet"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(connectState==connectIdle) connect();
    if(putState==getActive || putState==putActive) {
        string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            +  "PvaClientPut::issueGet get or put aleady active ";
        throw std::runtime_error(message);
    }
    putState = getActive;
    channelPut->get();
}

void epics::pvaClient::PvaClientPut::issuePut

(

)

Issue a put and return immediately.

Definition at line 374 of file pvaClientPut.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPut::issuePut"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << " pvStructure\n" << pvaClientData->getPVStructure()
           << " bitSet " << *pvaClientData->getChangedBitSet() << endl
           << endl;
    }
    if(connectState==connectIdle) connect();
    if(putState==getActive || putState==putActive) {
         string message = string("channel ")
            + pvaClientChannel->getChannel()->getChannelName()
            +  "PvaClientPut::issuePut get or put aleady active ";
         throw std::runtime_error(message);
    }
    putState = putActive;
    channelPut->put(pvaClientData->getPVStructure(),pvaClientData->getChangedBitSet());
}

epics::pvaClient::PvaClientPut::POINTER_DEFINITIONS

(

PvaClientPut

)

void epics::pvaClient::PvaClientPut::put

(

)

Call issuePut and then waitPut. An exception is thrown if get fails.

Definition at line 357 of file pvaClientPut.cpp.

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

void epics::pvaClient::PvaClientPut::setRequester

(

PvaClientPutRequesterPtr const &

pvaClientPutRequester

)

Set a user callback.

Parameters

pvaClientPutRequester

The requester which must be implemented by the caller.

Definition at line 428 of file pvaClientPut.cpp.

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

Status epics::pvaClient::PvaClientPut::waitConnect

(

)

Wait until the channelPut connection to the channel is complete.

Returns

status;

Definition at line 277 of file pvaClientPut.cpp.

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

Status epics::pvaClient::PvaClientPut::waitGet

(

)

Wait until get completes.

Returns

status

Definition at line 336 of file pvaClientPut.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPut::waitGet"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    {
        Lock xx(mutex);
        if(putState==putComplete) return channelGetPutStatus;
        if(putState!=getActive){
            string message = string("channel ")
                + pvaClientChannel->getChannel()->getChannelName()
                +  " PvaClientPut::waitGet illegal put state";
            throw std::runtime_error(message);
        }
    }
    waitForGetPut.wait();
    return channelGetPutStatus;
}

Status epics::pvaClient::PvaClientPut::waitPut

(

)

Wait until put completes.

Returns

status

Definition at line 394 of file pvaClientPut.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientPut::waitPut"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    {
        Lock xx(mutex);
        if(putState==putComplete) return channelGetPutStatus;
        if(putState!=putActive){
            string message = string("channel ")
                + pvaClientChannel->getChannel()->getChannelName()
                +  " PvaClientPut::waitPut illegal put state";
            throw std::runtime_error(message);
        }
    }
    waitForGetPut.wait();
    if(channelGetPutStatus.isOK()) pvaClientData->getChangedBitSet()->clear();
    return channelGetPutStatus;
}

Friends And Related Function Documentation

friend class ChannelPutRequesterImpl

friend

Definition at line 1304 of file pvaClient.h.

---

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

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