#include "responseHandlers.h"

Inheritance diagram for epics::pvAccess::ServerChannelPutGetRequesterImpl:

Collaboration diagram for epics::pvAccess::ServerChannelPutGetRequesterImpl:

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

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

Public Types inherited from epics::pvAccess::ChannelPutGetRequester
typedef ChannelPutGet	operation_type

Public Member Functions
virtual	~ServerChannelPutGetRequesterImpl ()

virtual void	channelPutGetConnect (const epics::pvData::Status &status, ChannelPutGet::shared_pointer const &channelPutGet, epics::pvData::Structure::const_shared_pointer const &putStructure, epics::pvData::Structure::const_shared_pointer const &getStructure) OVERRIDE FINAL

virtual void	getGetDone (const epics::pvData::Status &status, ChannelPutGet::shared_pointer const &channelPutGet, epics::pvData::PVStructure::shared_pointer const &pvStructure, epics::pvData::BitSet::shared_pointer const &bitSet) OVERRIDE FINAL

virtual void	getPutDone (const epics::pvData::Status &status, ChannelPutGet::shared_pointer const &channelPutGet, epics::pvData::PVStructure::shared_pointer const &pvStructure, epics::pvData::BitSet::shared_pointer const &bitSet) OVERRIDE FINAL

virtual void	putGetDone (const epics::pvData::Status &status, ChannelPutGet::shared_pointer const &channelPutGet, epics::pvData::PVStructure::shared_pointer const &pvStructure, epics::pvData::BitSet::shared_pointer const &bitSet) OVERRIDE FINAL

virtual void	destroy () OVERRIDE FINAL

ChannelPutGet::shared_pointer	getChannelPutGet ()

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::PVStructure::shared_pointer	getPutGetPVStructure ()

epics::pvData::BitSet::shared_pointer	getPutGetBitSet ()

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::ChannelPutGetRequester
	POINTER_DEFINITIONS (ChannelPutGetRequester)

virtual	~ChannelPutGetRequester ()

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

	ChannelBaseRequester ()

virtual	~ChannelBaseRequester ()

virtual void	channelDisconnect (bool destroy)

Static Public Member Functions
static ChannelPutGetRequester::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
	ServerChannelPutGetRequesterImpl (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 400 of file responseHandlers.h.

Member Typedef Documentation

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

Definition at line 407 of file responseHandlers.h.

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

Definition at line 406 of file responseHandlers.h.

Constructor & Destructor Documentation

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

protected

Definition at line 1570 of file responseHandlers.cpp.

                                                                          :
     BaseChannelRequester(context, channel, ioid, transport), _channelPutGet(), _pvPutStructure(), _pvGetStructure()
 {
 }

virtual epics::pvAccess::ServerChannelPutGetRequesterImpl::~ServerChannelPutGetRequesterImpl ( )

inlinevirtual

Definition at line 417 of file responseHandlers.h.

417 {}

Member Function Documentation

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

protected

Definition at line 1586 of file responseHandlers.cpp.

 {
     startRequest(QOS_INIT);
     shared_pointer thisPointer(shared_from_this());
     _channel->registerRequest(_ioid, thisPointer);
     INIT_EXCEPTION_GUARD(CMD_PUT_GET, _channelPutGet, _channel->getChannel()->createChannelPutGet(thisPointer, pvRequest));
 }

void epics::pvAccess::ServerChannelPutGetRequesterImpl::channelPutGetConnect	(	const epics::pvData::Status &	status,
		ChannelPutGet::shared_pointer const &	channelPutGet,
		epics::pvData::Structure::const_shared_pointer const &	putStructure,
		epics::pvData::Structure::const_shared_pointer const &	getStructure
	)

virtual

The client and server have both completed the createChannelPutGet request.

Parameters

status	Completion status.
channelPutGet	The channelPutGet interface or null if the request failed.
putStructure	The put structure introspection data or nullptr if the request failed.
getStructure	The get structure introspection data or nullptr if the request failed.

Implements epics::pvAccess::ChannelPutGetRequester.

Definition at line 1594 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         _channelPutGet = channelPutGet;
         if (_status.isSuccess())
         {
             _pvPutStructure = std::tr1::static_pointer_cast<PVStructure>(reuseOrCreatePVField(putStructure, _pvPutStructure));
             _pvPutBitSet = createBitSetFor(_pvPutStructure, _pvPutBitSet);
 
             _pvGetStructure = std::tr1::static_pointer_cast<PVStructure>(reuseOrCreatePVField(getStructure, _pvGetStructure));
             _pvGetBitSet = createBitSetFor(_pvGetStructure, _pvGetBitSet);
         }
     }
 
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 
     // self-destruction
     if (!status.isSuccess())
     {
         destroy();
     }
 }

ChannelPutGetRequester::shared_pointer epics::pvAccess::ServerChannelPutGetRequesterImpl::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 1576 of file responseHandlers.cpp.

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

void epics::pvAccess::ServerChannelPutGetRequesterImpl::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 1669 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 channelPutGet so that _channelPutGet.reset()
     // does not call ~ChannelPutGet (external code) while we are holding a lock
     ChannelPutGet::shared_pointer channelPutGet = _channelPutGet;
     {
         Lock guard(_mutex);
         _channel->unregisterRequest(_ioid);
 
         if (_channelPutGet)
         {
             _channelPutGet->destroy();
             _channelPutGet.reset();
         }
     }
 }

ChannelPutGet::shared_pointer epics::pvAccess::ServerChannelPutGetRequesterImpl::getChannelPutGet ( )

Definition at line 1691 of file responseHandlers.cpp.

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

void epics::pvAccess::ServerChannelPutGetRequesterImpl::getGetDone	(	const epics::pvData::Status &	status,
		ChannelPutGet::shared_pointer const &	channelPutGet,
		epics::pvData::PVStructure::shared_pointer const &	pvGetStructure,
		epics::pvData::BitSet::shared_pointer const &	getBitSet
	)

virtual

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

Parameters

status	Completion status.
channelPutGet	The channelPutGet interface.
pvGetStructure	The PVStructure that holds the getData or nullptr if the request failed.
getBitSet	getPVStructure changed bit-set or nullptr if the request failed.

Implements epics::pvAccess::ChannelPutGetRequester.

Definition at line 1621 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         if (_status.isSuccess())
         {
             *_pvGetBitSet = *bitSet;
             _pvGetStructure->copyUnchecked(*pvStructure, *_pvGetBitSet);
         }
     }
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 }

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

inlinevirtual

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

Implements epics::pvAccess::BaseChannelRequester.

Definition at line 434 of file responseHandlers.h.

434 { return getChannelPutGet(); }

epics::pvAccess::ServerChannelPutGetRequesterImpl::getChannelPutGet

ChannelPutGet::shared_pointer getChannelPutGet()

Definition: responseHandlers.cpp:1691

void epics::pvAccess::ServerChannelPutGetRequesterImpl::getPutDone	(	const epics::pvData::Status &	status,
		ChannelPutGet::shared_pointer const &	channelPutGet,
		epics::pvData::PVStructure::shared_pointer const &	pvPutStructure,
		epics::pvData::BitSet::shared_pointer const &	putBitSet
	)

virtual

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

Parameters

status	Completion status.
channelPutGet	The channelPutGet interface.
pvPutStructure	The PVStructure that holds the putData or nullptr if the request failed.
putBitSet	putPVStructure changed bit-set or nullptr if the request failed.

Implements epics::pvAccess::ChannelPutGetRequester.

Definition at line 1637 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         if (_status.isSuccess())
         {
             *_pvPutBitSet = *bitSet;
             _pvPutStructure->copyUnchecked(*pvStructure, *_pvPutBitSet);
         }
     }
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 }

BitSet::shared_pointer epics::pvAccess::ServerChannelPutGetRequesterImpl::getPutGetBitSet ( )

Definition at line 1703 of file responseHandlers.cpp.

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

PVStructure::shared_pointer epics::pvAccess::ServerChannelPutGetRequesterImpl::getPutGetPVStructure ( )

Definition at line 1697 of file responseHandlers.cpp.

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

void epics::pvAccess::ServerChannelPutGetRequesterImpl::putGetDone	(	const epics::pvData::Status &	status,
		ChannelPutGet::shared_pointer const &	channelPutGet,
		epics::pvData::PVStructure::shared_pointer const &	pvGetStructure,
		epics::pvData::BitSet::shared_pointer const &	getBitSet
	)

virtual

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

Parameters

status	Completion status.
channelPutGet	The channelPutGet interface.
pvGetStructure	The PVStructure that holds the getData or nullptr if the request failed.
getBitSet	getPVStructure changed bit-set or nullptr if the request failed.

Implements epics::pvAccess::ChannelPutGetRequester.

Definition at line 1653 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         if (_status.isSuccess())
         {
             *_pvGetBitSet = *bitSet;
             _pvGetStructure->copyUnchecked(*pvStructure, *_pvGetBitSet);
         }
     }
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 }

void epics::pvAccess::ServerChannelPutGetRequesterImpl::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 1709 of file responseHandlers.cpp.

 {
     const int32 request = getPendingRequest();
 
     ChannelPutGet::shared_pointer channelPutGet;
     {
         Lock guard(_mutex);
         channelPutGet = _channelPutGet;
         // we must respond to QOS_INIT (e.g. creation error)
         if (!channelPutGet && !(request & QOS_INIT))
             return;
     }
 
     control->startMessage(CMD_PUT_GET, sizeof(int32)/sizeof(int8) + 1);
     buffer->putInt(_ioid);
     buffer->putByte((int8)request);
     {
         Lock guard(_mutex);
         _status.serialize(buffer, control);
     }
 
     if (_status.isSuccess())
     {
         if ((QOS_INIT & request) != 0)
         {
             Lock guard(_mutex);
             control->cachedSerialize(_pvPutStructure->getStructure(), buffer);
             control->cachedSerialize(_pvGetStructure->getStructure(), buffer);
         }
         else if ((QOS_GET & request) != 0)
         {
             Lock guard(_mutex);
             _pvGetBitSet->serialize(buffer, control);
             _pvGetStructure->serialize(buffer, control, _pvGetBitSet.get());
         }
         else if ((QOS_GET_PUT & request) != 0)
         {
             ScopedLock lock(channelPutGet);
             //Lock guard(_mutex);
             _pvPutBitSet->serialize(buffer, control);
             _pvPutStructure->serialize(buffer, control, _pvPutBitSet.get());
         }
         else
         {
             ScopedLock lock(channelPutGet);
             //Lock guard(_mutex);
             _pvGetBitSet->serialize(buffer, control);
             _pvGetStructure->serialize(buffer, control, _pvGetBitSet.get());
         }
     }
 
     stopRequest();
 
     // lastRequest
     if ((QOS_DESTROY & request) != 0)
         destroy();
 }

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