pvAccessCPP 7.1.8
Loading...
Searching...
No Matches
epics::pvAccess::ChannelPutGet Class Referenceabstract

Channel access put/get request. More...

#include <client/pv/pvAccess.h>

Inheritance diagram for epics::pvAccess::ChannelPutGet:
Collaboration diagram for epics::pvAccess::ChannelPutGet:

Public Types

typedef std::tr1::shared_ptr< ChannelPutGetshared_pointer
 
typedef std::tr1::shared_ptr< const ChannelPutGetconst_shared_pointer
 
typedef std::tr1::weak_ptr< ChannelPutGetweak_pointer
 
typedef std::tr1::weak_ptr< const ChannelPutGetconst_weak_pointer
 
typedef ChannelPutGetRequester requester_type
 

Public Member Functions

virtual void putGet (epics::pvData::PVStructure::shared_pointer const &pvPutStructure, epics::pvData::BitSet::shared_pointer const &putBitSet)=0
 Issue a put/get request.
 
virtual void getPut ()=0
 Get the put PVStructure.
 
virtual void getGet ()=0
 Get the get PVStructure.
 
virtual std::tr1::shared_ptr< ChannelgetChannel ()=0
 Get a channel instance this request belongs to.
 
virtual void cancel ()=0
 Cancel any pending request.
 
virtual void lastRequest ()=0
 Announce next request as last request.
 
virtual void lock ()
 
virtual void unlock ()
 
virtual void destroy ()
 Destroy this instance.
 

Static Public Attributes

static size_t num_instances
 

Detailed Description

Channel access put/get request.

The put is performed first, followed optionally by a process request, and then by a get request.

Definition at line 684 of file pvAccess.h.

Member Typedef Documentation

◆ const_shared_pointer

std::tr1::shared_ptr<const ChannelPutGet> epics::pvAccess::ChannelPutGet::const_shared_pointer

Definition at line 686 of file pvAccess.h.

◆ const_weak_pointer

std::tr1::weak_ptr<const ChannelPutGet> epics::pvAccess::ChannelPutGet::const_weak_pointer

Definition at line 686 of file pvAccess.h.

◆ requester_type

◆ shared_pointer

std::tr1::shared_ptr<ChannelPutGet> epics::pvAccess::ChannelPutGet::shared_pointer

Definition at line 686 of file pvAccess.h.

◆ weak_pointer

std::tr1::weak_ptr<ChannelPutGet> epics::pvAccess::ChannelPutGet::weak_pointer

Definition at line 686 of file pvAccess.h.

Constructor & Destructor Documentation

◆ ~ChannelPutGet()

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

Definition at line 689 of file pvAccess.h.

Member Function Documentation

◆ cancel()

virtual void epics::pvAccess::ChannelRequest::cancel ( )
pure virtualinherited

Cancel any pending request.

Completion will be reported via request's response callback:

  • if cancel() request is issued after the request was already complete, request success/failure completion will be reported and cancel() request ignored.
  • if the request was actually canceled, cancellation completion is reported.

◆ destroy()

virtual void epics::pvAccess::Destroyable::destroy ( )
inlinevirtualinherited

Destroy this instance.

Reimplemented in epics::pvAccess::MonitorFIFO.

Definition at line 30 of file destroyable.h.

◆ getChannel()

virtual std::tr1::shared_ptr< Channel > epics::pvAccess::ChannelRequest::getChannel ( )
pure virtualinherited

Get a channel instance this request belongs to.

Returns
the channel instance.

◆ getGet()

virtual void epics::pvAccess::ChannelPutGet::getGet ( )
pure virtual

Get the get PVStructure.

The record will not be processed. Completion status is reported by calling ChannelPutGetRequester.getGetDone() callback.

◆ getPut()

virtual void epics::pvAccess::ChannelPutGet::getPut ( )
pure virtual

Get the put PVStructure.

The record will not be processed. Completion status is reported by calling ChannelPutGetRequester.getPutDone() callback.

◆ lastRequest()

virtual void epics::pvAccess::ChannelRequest::lastRequest ( )
pure virtualinherited

Announce next request as last request.

When last request will be completed (regardless of completion status) the remote and local instance will be destroyed.

◆ lock()

virtual void epics::pvAccess::Lockable::lock ( )
inlinevirtualinherited

Definition at line 97 of file pvAccess.h.

◆ putGet()

virtual void epics::pvAccess::ChannelPutGet::putGet ( epics::pvData::PVStructure::shared_pointer const & pvPutStructure,
epics::pvData::BitSet::shared_pointer const & putBitSet )
pure virtual

Issue a put/get request.

If process was requested when the ChannelPutGet was created this is a put, process, get. Completion status is reported by calling ChannelPutGetRequester.putGetDone() callback.

Parameters
pvPutStructureThe PVStructure that holds the putData.
putBitSetputPVStructure bit-set (selects what fields to put).

◆ unlock()

virtual void epics::pvAccess::Lockable::unlock ( )
inlinevirtualinherited

Definition at line 98 of file pvAccess.h.

Member Data Documentation

◆ num_instances

size_t epics::pvAccess::ChannelRequest::num_instances
staticinherited

Definition at line 212 of file pvAccess.h.


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