epics::pvAccess::ChannelArrayRequester Class Reference

The Requester for a ChannelArray. More...

#include <client/pv/pvAccess.h>

Inheritance diagram for epics::pvAccess::ChannelArrayRequester:

Collaboration diagram for epics::pvAccess::ChannelArrayRequester:

Public Types
typedef std::tr1::shared_ptr< ChannelArrayRequester >	shared_pointer
typedef std::tr1::shared_ptr< const ChannelArrayRequester >	const_shared_pointer
typedef std::tr1::weak_ptr< ChannelArrayRequester >	weak_pointer
typedef std::tr1::weak_ptr< const ChannelArrayRequester >	const_weak_pointer
typedef ChannelArray	operation_type

Public Member Functions
virtual void	channelArrayConnect (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray, epics::pvData::Array::const_shared_pointer const &array)=0
	Underlying Channel is connected and operation setup is complete.
virtual void	putArrayDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray)=0
	The request is done.
virtual void	getArrayDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray, epics::pvData::PVArray::shared_pointer const &pvArray)=0
	The request is done.
virtual void	getLengthDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray, size_t length)=0
	The request is done.
virtual void	setLengthDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray)=0
	The request is done.
virtual void	channelDisconnect (bool destroy)
	Notification when underlying Channel becomes DISCONNECTED or DESTORYED.
virtual std::string	getRequesterName ()=0
	The requester must have a name.
virtual void	message (std::string const &message, MessageType messageType=errorMessage)
	Push notification.

Static Public Attributes
static size_t	num_instances

Detailed Description

The Requester for a ChannelArray.

Definition at line 332 of file pvAccess.h.

Member Typedef Documentation

const_shared_pointer

typedef std::tr1::shared_ptr<const ChannelArrayRequester> epics::pvAccess::ChannelArrayRequester::const_shared_pointer

Definition at line 334 of file pvAccess.h.

const_weak_pointer

typedef std::tr1::weak_ptr<const ChannelArrayRequester> epics::pvAccess::ChannelArrayRequester::const_weak_pointer

Definition at line 334 of file pvAccess.h.

operation_type

typedef ChannelArray epics::pvAccess::ChannelArrayRequester::operation_type

Definition at line 335 of file pvAccess.h.

shared_pointer

typedef std::tr1::shared_ptr<ChannelArrayRequester> epics::pvAccess::ChannelArrayRequester::shared_pointer

Definition at line 334 of file pvAccess.h.

weak_pointer

typedef std::tr1::weak_ptr<ChannelArrayRequester> epics::pvAccess::ChannelArrayRequester::weak_pointer

Definition at line 334 of file pvAccess.h.

Constructor & Destructor Documentation

~ChannelArrayRequester()

virtual epics::pvAccess::ChannelArrayRequester::~ChannelArrayRequester ( )

inlinevirtual

Definition at line 337 of file pvAccess.h.

Member Function Documentation

channelArrayConnect()

virtual void epics::pvAccess::ChannelArrayRequester::channelArrayConnect ( const epics::pvData::Status & status, ChannelArray::shared_pointer const & channelArray, epics::pvData::Array::const_shared_pointer const & array )

pure virtual

Underlying Channel is connected and operation setup is complete.

May call putArray(), getArray(), getLength(), or setLength() to execute.

Parameters

status	Completion status.
channelArray	The channelArray interface or nullptr if the request failed.
pvArray	The PVArray that holds the data or nullptr if the request failed.

channelDisconnect()

virtual void epics::pvAccess::ChannelBaseRequester::channelDisconnect ( bool destroy )

inlinevirtualinherited

Notification when underlying Channel becomes DISCONNECTED or DESTORYED.

(re)connection is notified through a sub-class *Connect() method.

Any in-progress get()/put()/request()/start() is implicitly cancel()'d or stop()'d before this method is called.

Ownership of any PVStructures passed to completion callbacks (eg. ChannelGetRequester::getDone() ) is returned the operation

Parameters

destroy

true for final disconnect.

Definition at line 198 of file pvAccess.h.

getArrayDone()

virtual void epics::pvAccess::ChannelArrayRequester::getArrayDone ( const epics::pvData::Status & status, ChannelArray::shared_pointer const & channelArray, epics::pvData::PVArray::shared_pointer const & pvArray )

pure virtual

The request is done.

This is always called with no locks held.

Ownership of the PVArray is transfered to the ChannelArrayRequester until a subsequent call to ChannelArray::getArray() or ChannelArrayRequester::channelDisconnect().

Parameters

status	Completion status.
channelArray	The channelArray interface.
pvArray	The PVArray that holds the data or nullptr if the request failed.

getLengthDone()

virtual void epics::pvAccess::ChannelArrayRequester::getLengthDone ( const epics::pvData::Status & status, ChannelArray::shared_pointer const & channelArray, size_t length )

pure virtual

The request is done.

This is always called with no locks held.

Parameters

status	Completion status.
channelArray	The channelArray interface.
length	The length of the array, 0 if the request failed.

getRequesterName()

virtual std::string epics::pvAccess::Requester::getRequesterName ( )

pure virtualinherited

The requester must have a name.

Returns

The requester's name.

Implemented in epics::pvAccess::Channel, and epics::pvAccess::DefaultChannelRequester.

message()

virtual void epics::pvAccess::Requester::message ( std::string const & message, MessageType messageType = errorMessage )

virtualinherited

Push notification.

Reimplemented in epics::pvAccess::Channel.

putArrayDone()

virtual void epics::pvAccess::ChannelArrayRequester::putArrayDone ( const epics::pvData::Status & status, ChannelArray::shared_pointer const & channelArray )

pure virtual

The request is done.

This is always called with no locks held.

Ownership of PVArray passed to ChannelArray::putArray() returns to ChannelArrayRequester

Parameters

status	Completion status.
channelArray	The channelArray interface.

setLengthDone()

virtual void epics::pvAccess::ChannelArrayRequester::setLengthDone ( const epics::pvData::Status & status, ChannelArray::shared_pointer const & channelArray )

pure virtual

The request is done.

This is always called with no locks held.

Parameters

status	Completion status.
channelArray	The channelArray interface.

Member Data Documentation

num_instances

size_t epics::pvAccess::ChannelBaseRequester::num_instances

staticinherited

Definition at line 181 of file pvAccess.h.

---

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

• client/pv/pvAccess.h