This is Unofficial EPICS BASE Doxygen Site
Public Types | Public Member Functions | List of all members
epics::pvAccess::ChannelRPC Class Referenceabstract

#include "pvAccess.h"

+ Inheritance diagram for epics::pvAccess::ChannelRPC:
+ Collaboration diagram for epics::pvAccess::ChannelRPC:

Public Types

typedef ChannelRPCRequester requester_type
 

Public Member Functions

 POINTER_DEFINITIONS (ChannelRPC)
 
virtual ~ChannelRPC ()
 
virtual void request (epics::pvData::PVStructure::shared_pointer const &pvArgument)=0
 
- Public Member Functions inherited from epics::pvAccess::ChannelRequest
 POINTER_DEFINITIONS (ChannelRequest)
 
 ChannelRequest ()
 
virtual ~ChannelRequest ()
 
virtual std::tr1::shared_ptr< Channel > getChannel ()=0
 
virtual void cancel ()=0
 
virtual void lastRequest ()=0
 
- Public Member Functions inherited from epics::pvAccess::Destroyable
 POINTER_DEFINITIONS (Destroyable)
 
virtual void destroy ()=0
 
- Public Member Functions inherited from epics::pvAccess::Lockable
 POINTER_DEFINITIONS (Lockable)
 
virtual ~Lockable ()
 
virtual void lock ()
 
virtual void unlock ()
 

Additional Inherited Members

- Static Public Attributes inherited from epics::pvAccess::ChannelRequest
static size_t num_instances
 
- Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual ~Destroyable ()
 

Detailed Description

Handle for an RPC operation

Definition at line 783 of file pvAccess.h.

Member Typedef Documentation

typedef ChannelRPCRequester epics::pvAccess::ChannelRPC::requester_type

Definition at line 786 of file pvAccess.h.

Constructor & Destructor Documentation

virtual epics::pvAccess::ChannelRPC::~ChannelRPC ( )
inlinevirtual

Definition at line 788 of file pvAccess.h.

788 {}

Member Function Documentation

epics::pvAccess::ChannelRPC::POINTER_DEFINITIONS ( ChannelRPC  )
virtual void epics::pvAccess::ChannelRPC::request ( epics::pvData::PVStructure::shared_pointer const &  pvArgument)
pure virtual

Issue an RPC request to the channel.

Completion status is reported by calling ChannelRPCRequester::requestDone() callback, which may be called from this method.

Precondition
The underlying Channel must be connected, and this ChannelRPC valid. Otherwise the ChannelRPCRequester::requestDone() is called with an error.
Postcondition
After calling request(), the requestDone() callback will be called at some later time. May call ChannelRPC::cancel() to request to abort() this operation.
Parameters
pvArgumentThe argument structure for an RPC request.

Implemented in pvas::detail::SharedRPC, and epics::pvAccess::ChannelRPCServiceImpl.

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