This is Unofficial EPICS BASE Doxygen Site
epics::pvAccess::ChannelArrayRequester Class Referenceabstract

#include "pvAccess.h"

+ Inheritance diagram for epics::pvAccess::ChannelArrayRequester:
+ Collaboration diagram for epics::pvAccess::ChannelArrayRequester:

Public Types

typedef ChannelArray operation_type
 

Public Member Functions

 POINTER_DEFINITIONS (ChannelArrayRequester)
 
virtual ~ChannelArrayRequester ()
 
virtual void channelArrayConnect (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray, epics::pvData::Array::const_shared_pointer const &array)=0
 
virtual void putArrayDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray)=0
 
virtual void getArrayDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray, epics::pvData::PVArray::shared_pointer const &pvArray)=0
 
virtual void getLengthDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray, size_t length)=0
 
virtual void setLengthDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray)=0
 
- Public Member Functions inherited from epics::pvAccess::ChannelBaseRequester
 POINTER_DEFINITIONS (ChannelBaseRequester)
 
 ChannelBaseRequester ()
 
virtual ~ChannelBaseRequester ()
 
virtual void channelDisconnect (bool destroy)
 

Additional Inherited Members

- Static Public Attributes inherited from epics::pvAccess::ChannelBaseRequester
static size_t num_instances
 

Detailed Description

The Requester for a ChannelArray.

Definition at line 332 of file pvAccess.h.

Member Typedef Documentation

Constructor & Destructor Documentation

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

Definition at line 337 of file pvAccess.h.

337 {}

Member Function Documentation

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
statusCompletion status.
channelArrayThe channelArray interface or nullptr if the request failed.
pvArrayThe PVArray that holds the data or nullptr if the request failed.

Implemented in epics::pvAccess::ServerChannelArrayRequesterImpl.

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
statusCompletion status.
channelArrayThe channelArray interface.
pvArrayThe PVArray that holds the data or nullptr if the request failed.

Implemented in epics::pvAccess::ServerChannelArrayRequesterImpl.

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
statusCompletion status.
channelArrayThe channelArray interface.
lengthThe length of the array, 0 if the request failed.
epics::pvAccess::ChannelArrayRequester::POINTER_DEFINITIONS ( ChannelArrayRequester  )
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
statusCompletion status.
channelArrayThe channelArray interface.

Implemented in epics::pvAccess::ServerChannelArrayRequesterImpl.

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
statusCompletion status.
channelArrayThe channelArray interface.

Implemented in epics::pvAccess::ServerChannelArrayRequesterImpl.


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