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.
void	setRequester (PvaClientPutRequesterPtr const &pvaClientPutRequester)
	Set a user callback.
void	connect ()
	Call issueConnect and then waitConnect.
void	issueConnect ()
	Issue the channelPut connection to the channel.
epics::pvData::Status	waitConnect ()
	Wait until the channelPut connection to the channel is complete.
void	get ()
	Call issueGet and then waitGet.
void	issueGet ()
	Issue a get and return immediately.
epics::pvData::Status	waitGet ()
	Wait until get completes.
void	put ()
	Call issuePut and then waitPut. An exception is thrown if get fails.
void	issuePut ()
	Issue a put and return immediately.
epics::pvData::Status	waitPut ()
	Wait until put completes.
PvaClientPutDataPtr	getData ()
	Get the data/.
PvaClientChannelPtr	getPvaClientChannel ()
	Get the PvaClientChannel;.

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

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.

References epics::pvaClient::PvaClient::getDebug().

Member Function Documentation

connect()

void epics::pvaClient::PvaClientPut::connect

(

)

Call issueConnect and then waitConnect.

An exception is thrown if connect fails.

Exceptions

runtime_error

if failure.

Definition at line 228 of file pvaClientPut.cpp.

References epics::pvaClient::PvaClient::getDebug(), issueConnect(), and waitConnect().

Referenced by issueGet(), and issuePut().

create()

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

static

Create a PvaClientPut.

Parameters

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

Returns

The interface to the PvaClientPut.

Definition at line 82 of file pvaClientPut.cpp.

References ChannelPutRequesterImpl.

get()

void epics::pvaClient::PvaClientPut::get

(

)

Call issueGet and then waitGet.

An exception is thrown if get fails.

Exceptions

runtime_error

if failure.

Definition at line 274 of file pvaClientPut.cpp.

References epics::pvaClient::PvaClient::getDebug(), issueGet(), and waitGet().

Referenced by getData().

getData()

PvaClientPutDataPtr epics::pvaClient::PvaClientPut::getData

(

)

Get the data/.

Returns

The interface.

Definition at line 371 of file pvaClientPut.cpp.

References get(), and epics::pvaClient::PvaClient::getDebug().

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.

References epics::pvaClient::PvaClient::getDebug().

Referenced by connect().

issueGet()

void epics::pvaClient::PvaClientPut::issueGet

(

)

Issue a get and return immediately.

Definition at line 291 of file pvaClientPut.cpp.

References connect(), and epics::pvaClient::PvaClient::getDebug().

Referenced by get().

issuePut()

void epics::pvaClient::PvaClientPut::issuePut

(

)

Issue a put and return immediately.

Definition at line 338 of file pvaClientPut.cpp.

References connect(), and epics::pvaClient::PvaClient::getDebug().

Referenced by put().

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.

References epics::pvaClient::PvaClient::getDebug(), issuePut(), and waitPut().

setRequester()

void epics::pvaClient::PvaClientPut::setRequester

(

PvaClientPutRequesterPtr const &

pvaClientPutRequester

)

Set a user callback.

Parameters

pvaClientPutRequester

The requester which must be implemented by the caller.

Definition at line 383 of file pvaClientPut.cpp.

References epics::pvaClient::PvaClient::getDebug().

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.

References epics::pvaClient::PvaClient::getDebug().

Referenced by connect().

waitGet()

Status epics::pvaClient::PvaClientPut::waitGet

(

)

Wait until get completes.

Returns

status

Definition at line 309 of file pvaClientPut.cpp.

References epics::pvaClient::PvaClient::getDebug().

Referenced by get().

waitPut()

Status epics::pvaClient::PvaClientPut::waitPut

(

)

Wait until put completes.

Returns

status

Definition at line 358 of file pvaClientPut.cpp.

References epics::pvaClient::PvaClient::getDebug().

Referenced by put().

Friends And Related Symbol Documentation

ChannelPutRequesterImpl

friend class ChannelPutRequesterImpl

friend

Definition at line 1260 of file pvaClient.h.

Referenced by create().

---

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

• pv/pvaClient.h
• pvaClientPut.cpp