epics::pvAccess::ChannelPut Class Reference

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

#include <client/pv/pvAccess.h>

Inheritance diagram for epics::pvAccess::ChannelPut:

Collaboration diagram for epics::pvAccess::ChannelPut:

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.
virtual void	get ()=0
	Get the current data.
virtual std::tr1::shared_ptr< Channel >	getChannel ()=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

Interface for a channel access put request.

Definition at line 600 of file pvAccess.h.

Member Typedef Documentation

const_shared_pointer

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

Definition at line 602 of file pvAccess.h.

const_weak_pointer

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

Definition at line 602 of file pvAccess.h.

requester_type

ChannelPutRequester epics::pvAccess::ChannelPut::requester_type

Definition at line 603 of file pvAccess.h.

shared_pointer

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

Definition at line 602 of file pvAccess.h.

weak_pointer

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

Definition at line 602 of file pvAccess.h.

Constructor & Destructor Documentation

~ChannelPut()

virtual epics::pvAccess::ChannelPut::~ChannelPut ( )

inlinevirtual

Definition at line 605 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::ChannelPut::get ( )

pure virtual

Get the current data.

Ownership transfer as with ChannelGet::get()

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.

put()

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

pvPutStructure	The PVStructure that holds the putData.
putBitSet	putPVStructure 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:

• client/pv/pvAccess.h