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

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

#include <pv/pvaClient.h>

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

Definition at line 1323 of file pvaClient.h.

Constructor & Destructor Documentation

◆ ~PvaClientPutGet()

epics::pvaClient::PvaClientPutGet::~PvaClientPutGet ( )

Destructor.

Definition at line 124 of file pvaClientPutGet.cpp.

Member Function Documentation

◆ connect()

void epics::pvaClient::PvaClientPutGet::connect ( )

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions
runtime_errorif failure.

Definition at line 277 of file pvaClientPutGet.cpp.

◆ create()

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

Create a PvaClientPutGet.

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

Definition at line 96 of file pvaClientPutGet.cpp.

◆ getGet()

void epics::pvaClient::PvaClientPutGet::getGet ( )

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

Definition at line 372 of file pvaClientPutGet.cpp.

◆ getGetData()

PvaClientGetDataPtr epics::pvaClient::PvaClientPutGet::getGetData ( )

Get the get data.

Returns
The interface.

Definition at line 464 of file pvaClientPutGet.cpp.

◆ getPut()

void epics::pvaClient::PvaClientPutGet::getPut ( )

Call issuePut and then waitGetPut.

An exception is thrown if getPut fails.

Definition at line 418 of file pvaClientPutGet.cpp.

◆ getPutData()

PvaClientPutDataPtr epics::pvaClient::PvaClientPutGet::getPutData ( )

Get the put data.

Returns
The interface.

Definition at line 479 of file pvaClientPutGet.cpp.

◆ getPvaClientChannel()

PvaClientChannelPtr epics::pvaClient::PvaClientPutGet::getPvaClientChannel ( )

Get the PvaClientChannel;.

Returns
The interface.

Definition at line 505 of file pvaClientPutGet.cpp.

◆ issueConnect()

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 294 of file pvaClientPutGet.cpp.

◆ issueGetGet()

void epics::pvaClient::PvaClientPutGet::issueGetGet ( )

Issue a getGet and return immediately.

Definition at line 389 of file pvaClientPutGet.cpp.

◆ issueGetPut()

void epics::pvaClient::PvaClientPutGet::issueGetPut ( )

Issue a getPut and return immediately.

Definition at line 435 of file pvaClientPutGet.cpp.

◆ issuePutGet()

void epics::pvaClient::PvaClientPutGet::issuePutGet ( )

Issue a putGet and return immediately.

Definition at line 341 of file pvaClientPutGet.cpp.

◆ POINTER_DEFINITIONS()

epics::pvaClient::PvaClientPutGet::POINTER_DEFINITIONS ( PvaClientPutGet  )

◆ putGet()

void epics::pvaClient::PvaClientPutGet::putGet ( )

Call issuePutGet and then waitPutGet.

An exception is thrown if putGet fails.

Definition at line 324 of file pvaClientPutGet.cpp.

◆ setRequester()

void epics::pvaClient::PvaClientPutGet::setRequester ( PvaClientPutGetRequesterPtr const &  pvaClientPutGetRequester)

Set a user callback.

Parameters
pvaClientPutGetRequesterThe requester which must be implemented by the caller.

Definition at line 494 of file pvaClientPutGet.cpp.

◆ waitConnect()

Status epics::pvaClient::PvaClientPutGet::waitConnect ( )

Wait until the channelPutGet connection to the channel is complete.

Returns
status;

Definition at line 312 of file pvaClientPutGet.cpp.

◆ waitGetGet()

Status epics::pvaClient::PvaClientPutGet::waitGetGet ( )

Wait until getGet completes.

If failure getStatus can be called to get reason.

Returns
status

Definition at line 407 of file pvaClientPutGet.cpp.

◆ waitGetPut()

Status epics::pvaClient::PvaClientPutGet::waitGetPut ( )

Wait until getPut completes.

Returns
status

Definition at line 453 of file pvaClientPutGet.cpp.

◆ waitPutGet()

Status epics::pvaClient::PvaClientPutGet::waitPutGet ( )

Wait until putGet completes.

If failure getStatus can be called to get reason.

Returns
status

Definition at line 360 of file pvaClientPutGet.cpp.

Friends And Related Function Documentation

◆ ChannelPutGetRequesterImpl

friend class ChannelPutGetRequesterImpl
friend

Definition at line 1465 of file pvaClient.h.


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