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.
void	setRequester (PvaClientProcessRequesterPtr const &pvaClientProcessRequester)
	Set a user callback.
void	connect ()
	Call issueConnect and then waitConnect.
void	issueConnect ()
	Issue the channelProcess connection to the channel.
epics::pvData::Status	waitConnect ()
	Wait until the channelProcess connection to the channel is complete.
void	process ()
	Call issueProcess and then waitProcess.
void	issueProcess ()
	Issue a process request and return immediately.
epics::pvData::Status	waitProcess ()
	Wait until process completes.
PvaClientChannelPtr	getPvaClientChannel ()
	Get the PvaClientChannel;.

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

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.

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

Member Function Documentation

connect()

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 171 of file pvaClientProcess.cpp.

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

Referenced by issueProcess().

create()

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.

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

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.

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

Referenced by connect().

issueProcess()

void epics::pvaClient::PvaClientProcess::issueProcess

(

)

Issue a process request and return immediately.

Definition at line 229 of file pvaClientProcess.cpp.

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

Referenced by process().

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.

References epics::pvaClient::PvaClient::getDebug(), issueProcess(), and waitProcess().

setRequester()

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 258 of file pvaClientProcess.cpp.

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

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.

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

Referenced by connect().

waitProcess()

Status epics::pvaClient::PvaClientProcess::waitProcess

(

)

Wait until process completes.

Returns

status.

Definition at line 246 of file pvaClientProcess.cpp.

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

Referenced by process().

Friends And Related Symbol Documentation

ChannelProcessRequesterImpl

friend class ChannelProcessRequesterImpl

friend

Definition at line 953 of file pvaClient.h.

Referenced by create().

---

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

• pv/pvaClient.h
• pvaClientProcess.cpp