pvAccessCPP  7.1.5
Public Types | Public Member Functions | Static Public Attributes | List of all members
epics::pvAccess::ChannelGet Class Referenceabstract

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

#include <client/pv/pvAccess.h>

Inheritance diagram for epics::pvAccess::ChannelGet:
Inheritance graph
[legend]
Collaboration diagram for epics::pvAccess::ChannelGet:
Collaboration graph
[legend]

Public Types

typedef ChannelGetRequester requester_type
 

Public Member Functions

 POINTER_DEFINITIONS (ChannelGet)
 
virtual void get ()=0
 Get data from the channel. More...
 
 POINTER_DEFINITIONS (ChannelRequest)
 
 POINTER_DEFINITIONS (Destroyable)
 
 POINTER_DEFINITIONS (Lockable)
 
virtual std::tr1::shared_ptr< ChannelgetChannel ()=0
 Get a channel instance this request belongs to. More...
 
virtual void cancel ()=0
 Cancel any pending request. More...
 
virtual void lastRequest ()=0
 Announce next request as last request. More...
 
virtual void destroy ()
 Destroy this instance.
 
virtual void lock ()
 
virtual void unlock ()
 

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

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


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