epics::pvaClient::PvaClientProcess Class Reference

An easy to use alternative to ChannelProcess. More...

#include "pvaClient.h"

Inheritance diagram for epics::pvaClient::PvaClientProcess:

Collaboration diagram for epics::pvaClient::PvaClientProcess:

Public Member Functions
	POINTER_DEFINITIONS (PvaClientProcess)
	~PvaClientProcess ()
	Destructor. More...
void	setRequester (PvaClientProcessRequesterPtr const &pvaClientProcessRequester)
	Set a user callback. More...
void	connect ()
	Call issueConnect and then waitConnect. More...
void	issueConnect ()
	Issue the channelProcess connection to the channel. More...
epics::pvData::Status	waitConnect ()
	Wait until the channelProcess connection to the channel is complete. More...
void	process ()
	Call issueProcess and then waitProcess. More...
void	issueProcess ()
	Issue a process request and return immediately. More...
epics::pvData::Status	waitProcess ()
	Wait until process completes. More...
PvaClientChannelPtr	getPvaClientChannel ()
	Get the PvaClientChannel;. More...

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

Friends
class	ChannelProcessRequesterImpl

Detailed Description

An easy to use alternative to ChannelProcess.

Overview of PvaClientProcess

Definition at line 901 of file pvaClient.h.

Constructor & Destructor Documentation

epics::pvaClient::PvaClientProcess::~PvaClientProcess

(

)

Destructor.

Definition at line 105 of file pvaClientProcess.cpp.

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

Member Function Documentation

void epics::pvaClient::PvaClientProcess::connect

(

)

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions

runtime_error

if failure.

Definition at line 185 of file pvaClientProcess.cpp.

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

PvaClientProcessPtr epics::pvaClient::PvaClientProcess::create ( PvaClientPtr const &  pvaClient, PvaClientChannelPtr const &  pvaClientChannel, epics::pvData::PVStructurePtr const &  pvRequest  )

static

Create a PvaClientProcess.

Parameters

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

Returns

The interface to the PvaClientProcess.

Definition at line 70 of file pvaClientProcess.cpp.

{
    if(PvaClient::getDebug()) {
         cout<< "PvaClientProcess::create(pvaClient,channelName,pvRequest)\n"
             << " channelName " <<  pvaClientChannel->getChannel()->getChannelName()
             << " pvRequest " << pvRequest
             << endl;
    }
    PvaClientProcessPtr channelProcess(new PvaClientProcess(pvaClient,pvaClientChannel,pvRequest));
    channelProcess->channelProcessRequester = ChannelProcessRequesterImplPtr(
        new ChannelProcessRequesterImpl(channelProcess,pvaClient));
    return channelProcess;
}

PvaClientChannelPtr epics::pvaClient::PvaClientProcess::getPvaClientChannel

(

)

Get the PvaClientChannel;.

Returns

The interface.

Definition at line 304 of file pvaClientProcess.cpp.

{
    return pvaClientChannel;
}

void epics::pvaClient::PvaClientProcess::issueConnect

(

)

Issue the channelProcess connection to the channel.

This can only be called once.

Definition at line 200 of file pvaClientProcess.cpp.

{
     if(PvaClient::getDebug()) {
        cout << "PvaClientProcess::issueConnect"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(connectState!=connectIdle) {
        string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
            + " pvaClientProcess already connected ";
        throw std::runtime_error(message);
    }
    connectState = connectActive;
    channelProcessConnectStatus = Status(Status::STATUSTYPE_ERROR, "connect active");
    channelProcess = pvaClientChannel->getChannel()->createChannelProcess(channelProcessRequester,pvRequest);
}

void epics::pvaClient::PvaClientProcess::issueProcess

(

)

Issue a process request and return immediately.

Definition at line 253 of file pvaClientProcess.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientProcess::issueProcess"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    if(connectState==connectIdle) connect();
    if(processState==processActive) {
        string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
            + " PvaClientProcess::issueProcess process aleady active ";
        throw std::runtime_error(message);
    }
    processState = processActive;
    channelProcess->process();
}

epics::pvaClient::PvaClientProcess::POINTER_DEFINITIONS

(

PvaClientProcess

)

void epics::pvaClient::PvaClientProcess::process

(

)

Call issueProcess and then waitProcess.

An exception is thrown if process fails.

Definition at line 238 of file pvaClientProcess.cpp.

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

void epics::pvaClient::PvaClientProcess::setRequester

(

PvaClientProcessRequesterPtr const &

pvaClientProcessRequester

)

Set a user callback.

Parameters

pvaClientProcessRequester

The requester which must be implemented by the caller.

Definition at line 294 of file pvaClientProcess.cpp.

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

Status epics::pvaClient::PvaClientProcess::waitConnect

(

)

Wait until the channelProcess connection to the channel is complete.

Returns

status;

Definition at line 217 of file pvaClientProcess.cpp.

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

Status epics::pvaClient::PvaClientProcess::waitProcess

(

)

Wait until process completes.

Returns

status.

Definition at line 270 of file pvaClientProcess.cpp.

{
    if(PvaClient::getDebug()) {
        cout << "PvaClientProcess::waitProcess"
           << " channelName " << pvaClientChannel->getChannel()->getChannelName()
           << endl;
    }
    {
        Lock xx(mutex);
        if(processState==processComplete) {
            processState = processIdle;
            return channelProcessStatus;
        }
        if(processState!=processActive){
            string message = string("channel ") + pvaClientChannel->getChannel()->getChannelName()
                 + " PvaClientProcess::waitProcess llegal process state";
            throw std::runtime_error(message);
        }
    }
    waitForProcess.wait();
    processState = processComplete;
    return channelProcessStatus;
}

Friends And Related Function Documentation

friend class ChannelProcessRequesterImpl

friend

Definition at line 993 of file pvaClient.h.

---

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

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