An easy to use alternative to RPC.
More...
#include <pv/pvaClient.h>
An easy to use alternative to RPC.
Definition at line 1685 of file pvaClient.h.
◆ ~PvaClientRPC()
epics::pvaClient::PvaClientRPC::~PvaClientRPC |
( |
| ) |
|
◆ connect()
void epics::pvaClient::PvaClientRPC::connect |
( |
| ) |
|
Call issueConnect and then waitConnect.
An exception is thrown if connect fails.
Definition at line 216 of file pvaClientRPC.cpp.
◆ create() [1/2]
static PvaClientRPCPtr epics::pvaClient::PvaClientRPC::create |
( |
PvaClientPtr const & |
pvaClient, |
|
|
epics::pvAccess::Channel::shared_pointer const & |
channel |
|
) |
| |
|
static |
◆ create() [2/2]
static PvaClientRPCPtr epics::pvaClient::PvaClientRPC::create |
( |
PvaClientPtr const & |
pvaClient, |
|
|
epics::pvAccess::Channel::shared_pointer const & |
channel, |
|
|
epics::pvData::PVStructurePtr const & |
pvRequest |
|
) |
| |
|
static |
Create a PvaClientRPC.
- Parameters
-
&pvaClient | Interface to PvaClient |
channel | Interface to Channel |
pvRequest | The request structure. |
- Returns
- The interface to the PvaClientRPC.
◆ getResponseTimeout()
double epics::pvaClient::PvaClientRPC::getResponseTimeout |
( |
| ) |
|
|
inline |
Get the responseTimeout.
- Returns
- The value.
Definition at line 1724 of file pvaClient.h.
◆ issueConnect()
void epics::pvaClient::PvaClientRPC::issueConnect |
( |
| ) |
|
Issue the channelRPC connection to the channel.
This can only be called once. An exception is thrown if connect fails.
- Exceptions
-
Definition at line 232 of file pvaClientRPC.cpp.
◆ POINTER_DEFINITIONS()
epics::pvaClient::PvaClientRPC::POINTER_DEFINITIONS |
( |
PvaClientRPC |
| ) |
|
◆ request() [1/2]
epics::pvData::PVStructure::shared_pointer epics::pvaClient::PvaClientRPC::request |
( |
epics::pvData::PVStructure::shared_pointer const & |
pvArgument | ) |
|
Issue a request and wait for response.
Note that if responseTimeout is ( lt 0.0, ge 0.0) then this (will, will not) block until response completes or timeout.
- Parameters
-
pvArgument | The data to send to the service. |
- Returns
- The result
- Exceptions
-
◆ request() [2/2]
void epics::pvaClient::PvaClientRPC::request |
( |
epics::pvData::PVStructure::shared_pointer const & |
pvArgument, |
|
|
PvaClientRPCRequesterPtr const & |
pvaClientRPCRequester |
|
) |
| |
issue a request and return immediately.
- Parameters
-
pvArgument | The data to send to the service. |
pvaClientRPCRequester | The requester that is called with the result. |
- Exceptions
-
◆ setResponseTimeout()
void epics::pvaClient::PvaClientRPC::setResponseTimeout |
( |
double |
responseTimeout | ) |
|
|
inline |
Set a timeout for a request.
- Parameters
-
responseTimeout | The time in seconds to wait for a request to complete. |
Definition at line 1716 of file pvaClient.h.
◆ waitConnect()
Status epics::pvaClient::PvaClientRPC::waitConnect |
( |
| ) |
|
Wait until the channelRPC connection to the channel is complete.
- Returns
- status;
Definition at line 252 of file pvaClientRPC.cpp.
◆ RPCRequesterImpl
friend class RPCRequesterImpl |
|
friend |
The documentation for this class was generated from the following files: