#include "responseHandlers.h"

Inheritance diagram for epics::pvAccess::ServerChannelArrayRequesterImpl:

Collaboration diagram for epics::pvAccess::ServerChannelArrayRequesterImpl:

Public Types
typedef std::tr1::shared_ptr< ServerChannelArrayRequesterImpl >	shared_pointer

typedef std::tr1::shared_ptr< const ServerChannelArrayRequesterImpl >	const_shared_pointer

Public Types inherited from epics::pvAccess::ChannelArrayRequester
typedef ChannelArray	operation_type

Public Member Functions
virtual	~ServerChannelArrayRequesterImpl ()

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

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

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

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

virtual void	getLengthDone (const epics::pvData::Status &status, ChannelArray::shared_pointer const &channelArray, std::size_t length) OVERRIDE FINAL

virtual void	destroy () OVERRIDE FINAL

ChannelArray::shared_pointer	getChannelArray ()

virtual std::tr1::shared_ptr< ChannelRequest >	getOperation () OVERRIDE FINAL
	The Operation associated with this Requester, except for GetField and Monitor (which are special snowflakes...) More...

epics::pvData::PVArray::shared_pointer	getPVArray ()

virtual void	send (epics::pvData::ByteBuffer buffer, TransportSendControl control) OVERRIDE FINAL

Public Member Functions inherited from epics::pvAccess::BaseChannelRequester
	POINTER_DEFINITIONS (BaseChannelRequester)

	BaseChannelRequester (ServerContextImpl::shared_pointer const &context, std::tr1::shared_ptr< ServerChannel > const &channel, const pvAccessID ioid, Transport::shared_pointer const &transport)

virtual	~BaseChannelRequester ()

bool	startRequest (epics::pvData::int32 qos)

void	stopRequest ()

epics::pvData::int32	getPendingRequest ()

virtual std::string	getRequesterName () OVERRIDE FINAL

virtual void	message (std::string const &message, epics::pvData::MessageType messageType) OVERRIDE FINAL

virtual void	stats (Stats &s) const OVERRIDE FINAL
	Query current counter values. More...

Public Member Functions inherited from epics::pvAccess::TransportSender
	POINTER_DEFINITIONS (TransportSender)

	TransportSender ()

virtual	~TransportSender ()

Public Member Functions inherited from epics::pvAccess::Lockable
	POINTER_DEFINITIONS (Lockable)

virtual	~Lockable ()

virtual void	lock ()

virtual void	unlock ()

Public Member Functions inherited from epics::pvAccess::fair_queue< T >::entry
	entry ()

	~entry ()

Public Member Functions inherited from epics::pvAccess::NetStats
virtual	~NetStats ()

Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)

Public Member Functions inherited from epics::pvAccess::ChannelArrayRequester
	POINTER_DEFINITIONS (ChannelArrayRequester)

virtual	~ChannelArrayRequester ()

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

Public Member Functions inherited from epics::pvAccess::ChannelBaseRequester
	POINTER_DEFINITIONS (ChannelBaseRequester)

	ChannelBaseRequester ()

virtual	~ChannelBaseRequester ()

virtual void	channelDisconnect (bool destroy)

Static Public Member Functions
static ChannelArrayRequester::shared_pointer	create (ServerContextImpl::shared_pointer const &context, std::tr1::shared_ptr< ServerChannel > const &channel, const pvAccessID ioid, Transport::shared_pointer const &transport, epics::pvData::PVStructure::shared_pointer const &pvRequest)

Static Public Member Functions inherited from epics::pvAccess::BaseChannelRequester
static void	message (Transport::shared_pointer const &transport, const pvAccessID ioid, const std::string message, const epics::pvData::MessageType messageType)

static void	sendFailureMessage (const epics::pvData::int8 command, Transport::shared_pointer const &transport, const pvAccessID ioid, const epics::pvData::int8 qos, const epics::pvData::Status status)

Protected Member Functions
	ServerChannelArrayRequesterImpl (ServerContextImpl::shared_pointer const &context, std::tr1::shared_ptr< ServerChannel > const &channel, const pvAccessID ioid, Transport::shared_pointer const &transport)

void	activate (epics::pvData::PVStructure::shared_pointer const &pvRequest)

Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Additional Inherited Members
Public Attributes inherited from epics::pvAccess::TransportSender
size_t	bytesTX

size_t	bytesRX

Static Public Attributes inherited from epics::pvAccess::BaseChannelRequester
static const epics::pvData::Status	okStatus = Status()

static const epics::pvData::Status	badCIDStatus

static const epics::pvData::Status	badIOIDStatus

static const epics::pvData::Status	noReadACLStatus

static const epics::pvData::Status	noWriteACLStatus

static const epics::pvData::Status	noProcessACLStatus

static const epics::pvData::Status	otherRequestPendingStatus

static const epics::pvData::Status	notAChannelRequestStatus

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

Protected Attributes inherited from epics::pvAccess::BaseChannelRequester
const pvAccessID	_ioid

const Transport::shared_pointer	_transport

const std::tr1::shared_ptr< ServerChannel >	_channel

epics::pvData::Mutex	_mutex

Detailed Description

Definition at line 534 of file responseHandlers.h.

Member Typedef Documentation

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

Definition at line 541 of file responseHandlers.h.

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

Definition at line 540 of file responseHandlers.h.

Constructor & Destructor Documentation

epics::pvAccess::ServerChannelArrayRequesterImpl::ServerChannelArrayRequesterImpl	(	ServerContextImpl::shared_pointer const &	context,
		std::tr1::shared_ptr< ServerChannel > const &	channel,
		const pvAccessID	ioid,
		Transport::shared_pointer const &	transport
	)

protected

Definition at line 2209 of file responseHandlers.cpp.

                                                                      :
     BaseChannelRequester(context, channel, ioid, transport)
 {
 }

virtual epics::pvAccess::ServerChannelArrayRequesterImpl::~ServerChannelArrayRequesterImpl ( )

inlinevirtual

Definition at line 551 of file responseHandlers.h.

551 {}

Member Function Documentation

void epics::pvAccess::ServerChannelArrayRequesterImpl::activate ( epics::pvData::PVStructure::shared_pointer const & pvRequest )

protected

Definition at line 2227 of file responseHandlers.cpp.

 {
     startRequest(QOS_INIT);
     shared_pointer thisPointer(shared_from_this());
     _channel->registerRequest(_ioid, thisPointer);
     INIT_EXCEPTION_GUARD(CMD_ARRAY, _channelArray, _channel->getChannel()->createChannelArray(thisPointer, pvRequest));
 }

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

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.

Implements epics::pvAccess::ChannelArrayRequester.

Definition at line 2235 of file responseHandlers.cpp.

 {
     if (status.isSuccess() && array->getArraySizeType() == Array::fixed)
     {
         Lock guard(_mutex);
         _status = Status(Status::STATUSTYPE_ERROR, "fixed sized array returned as a ChannelArray array instance");
         _channelArray.reset();
         _pvArray.reset();
     }
     else
     {
         Lock guard(_mutex);
         _status = status;
         _channelArray = channelArray;
         if (_status.isSuccess())
         {
             _pvArray = std::tr1::static_pointer_cast<PVArray>(reuseOrCreatePVField(array, _pvArray));
         }
     }
 
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 
     // self-destruction
     if (!status.isSuccess())
     {
         destroy();
     }
 }

ChannelArrayRequester::shared_pointer epics::pvAccess::ServerChannelArrayRequesterImpl::create	(	ServerContextImpl::shared_pointer const &	context,
		std::tr1::shared_ptr< ServerChannel > const &	channel,
		const pvAccessID	ioid,
		Transport::shared_pointer const &	transport,
		epics::pvData::PVStructure::shared_pointer const &	pvRequest
	)

static

Definition at line 2216 of file responseHandlers.cpp.

 {
     // TODO use std::make_shared
     std::tr1::shared_ptr<ServerChannelArrayRequesterImpl> tp(new ServerChannelArrayRequesterImpl(context, channel, ioid, transport));
     ChannelArrayRequester::shared_pointer thisPointer = tp;
     static_cast<ServerChannelArrayRequesterImpl*>(thisPointer.get())->activate(pvRequest);
     return thisPointer;
 }

void epics::pvAccess::ServerChannelArrayRequesterImpl::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 2311 of file responseHandlers.cpp.

 {
     // keep a reference to ourselves as the owner
     // could release its reference and we don't want to be
     // destroyed prematurely
     shared_pointer self(shared_from_this());
 
     // hold a reference to channelArray so that _channelArray.reset()
     // does not call ~ChannelArray (external code) while we are holding a lock
     ChannelArray::shared_pointer channelArray = _channelArray;
     {
         Lock guard(_mutex);
         _channel->unregisterRequest(_ioid);
 
         if (_channelArray)
         {
             _channelArray->destroy();
             _channelArray.reset();
         }
     }
 }

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

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.

Implements epics::pvAccess::ChannelArrayRequester.

Definition at line 2265 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         if (_status.isSuccess())
         {
             _pvArray->copyUnchecked(*pvArray);
         }
     }
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 }

ChannelArray::shared_pointer epics::pvAccess::ServerChannelArrayRequesterImpl::getChannelArray ( )

Definition at line 2333 of file responseHandlers.cpp.

 {
     //Lock guard(_mutex);
     return _channelArray;
 }

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

virtual

Definition at line 2299 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         _length = length;
     }
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 }

virtual std::tr1::shared_ptr<ChannelRequest> epics::pvAccess::ServerChannelArrayRequesterImpl::getOperation ( )

inlinevirtual

The Operation associated with this Requester, except for GetField and Monitor (which are special snowflakes...)

Implements epics::pvAccess::BaseChannelRequester.

Definition at line 569 of file responseHandlers.h.

569 { return getChannelArray(); }

epics::pvAccess::ServerChannelArrayRequesterImpl::getChannelArray

ChannelArray::shared_pointer getChannelArray()

Definition: responseHandlers.cpp:2333

PVArray::shared_pointer epics::pvAccess::ServerChannelArrayRequesterImpl::getPVArray ( )

Definition at line 2339 of file responseHandlers.cpp.

 {
     //Lock guard(_mutex);
     return _pvArray;
 }

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

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.

Implements epics::pvAccess::ChannelArrayRequester.

Definition at line 2279 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
     }
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 }

void epics::pvAccess::ServerChannelArrayRequesterImpl::send	(	epics::pvData::ByteBuffer *	buffer,
		TransportSendControl *	control
	)

virtual

Called by transport. By this call transport gives callee ownership over the buffer. Calls on TransportSendControl instance must be made from calling thread. Moreover, ownership is valid only for the time of call of this method. NOTE: these limitations allow efficient implementation.

Implements epics::pvAccess::TransportSender.

Definition at line 2345 of file responseHandlers.cpp.

 {
     const int32 request = getPendingRequest();
 
     ChannelArray::shared_pointer channelArray;
     {
         Lock guard(_mutex);
         channelArray = _channelArray;
         // we must respond to QOS_INIT (e.g. creation error)
         if (!channelArray && !(request & QOS_INIT))
             return;
     }
 
     control->startMessage((int32)CMD_ARRAY, sizeof(int32)/sizeof(int8) + 1);
     buffer->putInt(_ioid);
     buffer->putByte((int8)request);
     {
         Lock guard(_mutex);
         _status.serialize(buffer, control);
     }
 
     if (_status.isSuccess())
     {
         if ((QOS_GET & request) != 0)
         {
             //Lock guard(_mutex);
             ScopedLock lock(channelArray);
             _pvArray->serialize(buffer, control, 0, _pvArray->getLength());
         }
         else if ((QOS_PROCESS & request) != 0)
         {
             //Lock guard(_mutex);
             SerializeHelper::writeSize(_length, buffer, control);
         }
         else if ((QOS_INIT & request) != 0)
         {
             Lock guard(_mutex);
             control->cachedSerialize(_pvArray->getArray(), buffer);
         }
     }
 
     stopRequest();
 
     // lastRequest
     if ((QOS_DESTROY & request) != 0)
         destroy();
 }

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

virtual

The request is done. This is always called with no locks held.

Parameters

status	Completion status.
channelArray	The channelArray interface.

Implements epics::pvAccess::ChannelArrayRequester.

Definition at line 2289 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
     }
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 }

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

modules/pvAccess/src/server/pv/responseHandlers.h
modules/pvAccess/src/server/responseHandlers.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation