epics::pvaClient::PvaClientGet Class Reference

An easy to use alternative to ChannelGet. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientGet:

Collaboration diagram for epics::pvaClient::PvaClientGet:

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

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

Friends
class	ChannelGetRequesterImpl

Detailed Description

An easy to use alternative to ChannelGet.

Overview of PvaClientGet

Definition at line 1035 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientGet::~PvaClientGet

(

)

Destructor.

Definition at line 106 of file pvaClientGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout<< "PvaClientGet::~PvaClientGet channelName "
           << pvaClientChannel->getChannel()->getChannelName() << "\n";
    }
}

Member Function Documentation

void epics::pvaClient::PvaClientGet::connect

(

)

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions

runtime_error

if failure.

Definition at line 215 of file pvaClientGet.cpp.

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

PvaClientGetPtr epics::pvaClient::PvaClientGet::create ( PvaClientPtr const &  pvaClient, PvaClientChannelPtr const &  pvaClientChannel, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Create a PvaClientGet.

Parameters

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

Returns

The interface to the PvaClientGet.

Definition at line 73 of file pvaClientGet.cpp.

{
    if(PvaClient::getDebug()) {
         cout<< "PvaClientGet::create(pvaClient,channelName,pvRequest)\n"
             << " channelName " <<  pvaClientChannel->getChannel()->getChannelName()
             << " pvRequest " << pvRequest
             << endl;
    }
    PvaClientGetPtr clientGet(new PvaClientGet(pvaClient,pvaClientChannel,pvRequest));
    clientGet->channelGetRequester = ChannelGetRequesterImplPtr(
        new ChannelGetRequesterImpl(clientGet,pvaClient));
    return clientGet;
}

void epics::pvaClient::PvaClientGet::get

(

)

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

Definition at line 268 of file pvaClientGet.cpp.

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

PvaClientGetDataPtr epics::pvaClient::PvaClientGet::getData

(

)

Get the data/.

Returns

The interface.

Definition at line 320 of file pvaClientGet.cpp.

{
    if(PvaClient::getDebug()) {
           cout<< "PvaClientGet::getData  channelName "
               << pvaClientChannel->getChannel()->getChannelName() << "\n";
    }
    checkConnectState();
    if(getState==getIdle) get();
    return pvaClientData;
}

PvaClientChannelPtr epics::pvaClient::PvaClientGet::getPvaClientChannel

(

)

Get the PvaClientChannel;.

Returns

The interface.

Definition at line 340 of file pvaClientGet.cpp.

{
    return pvaClientChannel;
}

void epics::pvaClient::PvaClientGet::issueConnect

(

)

create the channelGet connection to the channel.

This can only be called once.

Definition at line 229 of file pvaClientGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientGet::issueConnect channelName "
           << pvaClientChannel->getChannel()->getChannelName() << "\n";
    }
    if(connectState!=connectIdle) {
        string message = string("channel ")  + pvaClientChannel->getChannel()->getChannelName()
            + " pvaClientGet already connected ";
        throw std::runtime_error(message);
    }
    connectState = connectActive;
    channelGetConnectStatus = Status(Status::STATUSTYPE_ERROR, "connect active");
    channelGet = pvaClientChannel->getChannel()->createChannelGet(channelGetRequester,pvRequest);
}

void epics::pvaClient::PvaClientGet::issueGet

(

)

Issue a get and return immediately.

Definition at line 282 of file pvaClientGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientGet::issueGet channelName "
           << pvaClientChannel->getChannel()->getChannelName() << "\n";
    }
    if(connectState==connectIdle) connect();
    if(getState==getActive) {
        string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientGet::issueGet get aleady active ";
        throw std::runtime_error(message);
    }
    getState = getActive;
    channelGet->get();
}

epics::pvaClient::PvaClientGet::POINTER_DEFINITIONS

(

PvaClientGet

)

void epics::pvaClient::PvaClientGet::setRequester

(

PvaClientGetRequesterPtr const &

pvaClientGetRequester

)

Set a user callback.

Parameters

pvaClientGetRequester

The requester which must be implemented by the caller.

Definition at line 331 of file pvaClientGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientGet::setRequester channelName "
           << pvaClientChannel->getChannel()->getChannelName() << "\n";
    }
    this->pvaClientGetRequester = pvaClientGetRequester;
}

Status epics::pvaClient::PvaClientGet::waitConnect

(

)

Wait until the channelGet connection to the channel is complete.

Returns

status;

Definition at line 245 of file pvaClientGet.cpp.

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

Status epics::pvaClient::PvaClientGet::waitGet

(

)

Wait until get completes.

Returns

status;

Definition at line 298 of file pvaClientGet.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientGet::waitGet channelName "
           << pvaClientChannel->getChannel()->getChannelName() << "\n";
    }
    {
        Lock xx(mutex);
        if(getState==getComplete) {
            getState = getIdle;
            return channelGetStatus;
        }
        if(getState!=getActive){
            string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
                + " PvaClientGet::waitGet llegal get state";
            throw std::runtime_error(message);
        }
    }
    waitForGet.wait();
    getState = getComplete;
    return channelGetStatus;
}

Friends And Related Function Documentation

friend class ChannelGetRequesterImpl

friend

Definition at line 1137 of file pvaClient.h.

---

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

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