pvaClientCPP  4.8.1-dev
Public Member Functions | Static Public Member Functions | Friends | List of all members
epics::pvaClient::PvaClientProcess Class Reference

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

#include <pv/pvaClient.h>

Inheritance 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.

Definition at line 861 of file pvaClient.h.

Constructor & Destructor Documentation

◆ ~PvaClientProcess()

epics::pvaClient::PvaClientProcess::~PvaClientProcess ( )

Destructor.

Definition at line 105 of file pvaClientProcess.cpp.

Member Function Documentation

◆ connect()

void epics::pvaClient::PvaClientProcess::connect ( )

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions
runtime_errorif failure.

Definition at line 171 of file pvaClientProcess.cpp.

◆ create()

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

Create a PvaClientProcess.

Parameters
pvaClientInterface to PvaClient
pvaClientChannelInterface to Channel
pvRequestThe request structure.
Returns
The interface to the PvaClientProcess.

Definition at line 70 of file pvaClientProcess.cpp.

◆ getPvaClientChannel()

PvaClientChannelPtr epics::pvaClient::PvaClientProcess::getPvaClientChannel ( )

Get the PvaClientChannel;.

Returns
The interface.

Definition at line 268 of file pvaClientProcess.cpp.

◆ issueConnect()

void epics::pvaClient::PvaClientProcess::issueConnect ( )

Issue the channelProcess connection to the channel.

This can only be called once.

Definition at line 186 of file pvaClientProcess.cpp.

◆ issueProcess()

void epics::pvaClient::PvaClientProcess::issueProcess ( )

Issue a process request and return immediately.

Definition at line 229 of file pvaClientProcess.cpp.

◆ POINTER_DEFINITIONS()

epics::pvaClient::PvaClientProcess::POINTER_DEFINITIONS ( PvaClientProcess  )

◆ process()

void epics::pvaClient::PvaClientProcess::process ( )

Call issueProcess and then waitProcess.

An exception is thrown if process fails.

Definition at line 214 of file pvaClientProcess.cpp.

◆ setRequester()

void epics::pvaClient::PvaClientProcess::setRequester ( PvaClientProcessRequesterPtr const &  pvaClientProcessRequester)

Set a user callback.

Parameters
pvaClientProcessRequesterThe requester which must be implemented by the caller.

Definition at line 258 of file pvaClientProcess.cpp.

◆ waitConnect()

Status epics::pvaClient::PvaClientProcess::waitConnect ( )

Wait until the channelProcess connection to the channel is complete.

Returns
status;

Definition at line 203 of file pvaClientProcess.cpp.

◆ waitProcess()

Status epics::pvaClient::PvaClientProcess::waitProcess ( )

Wait until process completes.

Returns
status.

Definition at line 246 of file pvaClientProcess.cpp.

Friends And Related Function Documentation

◆ ChannelProcessRequesterImpl

friend class ChannelProcessRequesterImpl
friend

Definition at line 953 of file pvaClient.h.


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