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

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

#include <pv/pvaClient.h>

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

Definition at line 1147 of file pvaClient.h.

Constructor & Destructor Documentation

◆ ~PvaClientPut()

epics::pvaClient::PvaClientPut::~PvaClientPut ( )

Destructor.

Definition at line 111 of file pvaClientPut.cpp.

Member Function Documentation

◆ connect()

void epics::pvaClient::PvaClientPut::connect ( )

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions
runtime_errorif failure.

Definition at line 228 of file pvaClientPut.cpp.

◆ create()

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

Create a PvaClientPut.

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

Definition at line 82 of file pvaClientPut.cpp.

◆ get()

void epics::pvaClient::PvaClientPut::get ( )

Call issueGet and then waitGet.

An exception is thrown if get fails.

Exceptions
runtime_errorif failure.

Definition at line 274 of file pvaClientPut.cpp.

◆ getData()

PvaClientPutDataPtr epics::pvaClient::PvaClientPut::getData ( )

Get the data/.

Returns
The interface.

Definition at line 371 of file pvaClientPut.cpp.

◆ getPvaClientChannel()

PvaClientChannelPtr epics::pvaClient::PvaClientPut::getPvaClientChannel ( )

Get the PvaClientChannel;.

Returns
The interface.

Definition at line 393 of file pvaClientPut.cpp.

◆ issueConnect()

void epics::pvaClient::PvaClientPut::issueConnect ( )

Issue the channelPut connection to the channel.

This can only be called once.

Definition at line 245 of file pvaClientPut.cpp.

◆ issueGet()

void epics::pvaClient::PvaClientPut::issueGet ( )

Issue a get and return immediately.

Definition at line 291 of file pvaClientPut.cpp.

◆ issuePut()

void epics::pvaClient::PvaClientPut::issuePut ( )

Issue a put and return immediately.

Definition at line 338 of file pvaClientPut.cpp.

◆ POINTER_DEFINITIONS()

epics::pvaClient::PvaClientPut::POINTER_DEFINITIONS ( PvaClientPut  )

◆ put()

void epics::pvaClient::PvaClientPut::put ( )

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

Definition at line 321 of file pvaClientPut.cpp.

◆ setRequester()

void epics::pvaClient::PvaClientPut::setRequester ( PvaClientPutRequesterPtr const &  pvaClientPutRequester)

Set a user callback.

Parameters
pvaClientPutRequesterThe requester which must be implemented by the caller.

Definition at line 383 of file pvaClientPut.cpp.

◆ waitConnect()

Status epics::pvaClient::PvaClientPut::waitConnect ( )

Wait until the channelPut connection to the channel is complete.

Returns
status;

Definition at line 263 of file pvaClientPut.cpp.

◆ waitGet()

Status epics::pvaClient::PvaClientPut::waitGet ( )

Wait until get completes.

Returns
status

Definition at line 309 of file pvaClientPut.cpp.

◆ waitPut()

Status epics::pvaClient::PvaClientPut::waitPut ( )

Wait until put completes.

Returns
status

Definition at line 358 of file pvaClientPut.cpp.

Friends And Related Function Documentation

◆ ChannelPutRequesterImpl

friend class ChannelPutRequesterImpl
friend

Definition at line 1260 of file pvaClient.h.


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