pvAccessCPP  7.1.7
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Static Public Attributes | List of all members
epics::pvAccess::ChannelPut Class Referenceabstract

Interface for a channel access put request. More...

#include <client/pv/pvAccess.h>

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

Public Types

typedef std::tr1::shared_ptr
< ChannelPut
shared_pointer
 
typedef std::tr1::shared_ptr
< const ChannelPut
const_shared_pointer
 
typedef std::tr1::weak_ptr
< ChannelPut
weak_pointer
 
typedef std::tr1::weak_ptr
< const ChannelPut
const_weak_pointer
 
typedef ChannelPutRequester requester_type
 

Public Member Functions

virtual void put (epics::pvData::PVStructure::shared_pointer const &pvPutStructure, epics::pvData::BitSet::shared_pointer const &putBitSet)=0
 Put data to a channel. More...
 
virtual void get ()=0
 Get the current data. More...
 
virtual std::tr1::shared_ptr
< Channel
getChannel ()=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

Interface for a channel access put request.

Definition at line 600 of file pvAccess.h.

Member Function Documentation

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.
virtual void epics::pvAccess::ChannelPut::get ( )
pure virtual

Get the current data.

Ownership transfer as with ChannelGet::get()

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

Get a channel instance this request belongs to.

Returns
the channel instance.
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.

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

Put data to a channel.

Completion status is reported by calling ChannelPutRequester::putDone()

Ownership of the PVStructure is transfered to the ChannelPut until ChannelPutRequester::putDone() or ChannelPutRequester::channelDisconnect() is called.

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

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