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

Request to get data from a channel. More...

#include <client/pv/pvAccess.h>

Inheritance diagram for epics::pvAccess::ChannelGet:
Collaboration diagram for epics::pvAccess::ChannelGet:

Public Types

typedef std::tr1::shared_ptr< ChannelGetshared_pointer
 
typedef std::tr1::shared_ptr< const ChannelGetconst_shared_pointer
 
typedef std::tr1::weak_ptr< ChannelGetweak_pointer
 
typedef std::tr1::weak_ptr< const ChannelGetconst_weak_pointer
 
typedef ChannelGetRequester requester_type
 

Public Member Functions

virtual void get ()=0
 Get data from the channel.
 
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

Request to get data from a channel.

Definition at line 489 of file pvAccess.h.

Member Typedef Documentation

◆ const_shared_pointer

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

Definition at line 491 of file pvAccess.h.

◆ const_weak_pointer

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

Definition at line 491 of file pvAccess.h.

◆ requester_type

◆ shared_pointer

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

Definition at line 491 of file pvAccess.h.

◆ weak_pointer

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

Definition at line 491 of file pvAccess.h.

Constructor & Destructor Documentation

◆ ~ChannelGet()

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

Definition at line 494 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.

◆ get()

virtual void epics::pvAccess::ChannelGet::get ( )
pure virtual

Get data from the channel.

Ownership of the PVStructure passed to ChannelGetRequester::getDone() is returned to the ChannelGet.

Completion status is reported by calling ChannelGetRequester::getDone() callback.

◆ 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.

◆ 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.

◆ 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: