#include "responseHandlers.h"

Inheritance diagram for epics::pvAccess::ServerChannelPutRequesterImpl:

Collaboration diagram for epics::pvAccess::ServerChannelPutRequesterImpl:

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

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

Public Types inherited from epics::pvAccess::ChannelPutRequester
typedef ChannelPut	operation_type

Public Member Functions
virtual	~ServerChannelPutRequesterImpl ()

virtual void	channelPutConnect (const epics::pvData::Status &status, ChannelPut::shared_pointer const &channelPut, epics::pvData::Structure::const_shared_pointer const &structure) OVERRIDE FINAL

virtual void	putDone (const epics::pvData::Status &status, ChannelPut::shared_pointer const &channelPut) OVERRIDE FINAL

virtual void	getDone (const epics::pvData::Status &status, ChannelPut::shared_pointer const &channelPut, epics::pvData::PVStructure::shared_pointer const &pvStructure, epics::pvData::BitSet::shared_pointer const &bitSet) OVERRIDE FINAL

virtual void	destroy () OVERRIDE FINAL

ChannelPut::shared_pointer	getChannelPut ()

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::BitSet::shared_pointer	getPutBitSet ()

epics::pvData::PVStructure::shared_pointer	getPutPVStructure ()

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

virtual	~ChannelPutRequester ()

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

	ChannelBaseRequester ()

virtual	~ChannelBaseRequester ()

virtual void	channelDisconnect (bool destroy)

Static Public Member Functions
static ChannelPutRequester::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
	ServerChannelPutRequesterImpl (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 342 of file responseHandlers.h.

Member Typedef Documentation

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

Definition at line 349 of file responseHandlers.h.

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

Definition at line 348 of file responseHandlers.h.

Constructor & Destructor Documentation

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

protected

Definition at line 1328 of file responseHandlers.cpp.

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

virtual epics::pvAccess::ServerChannelPutRequesterImpl::~ServerChannelPutRequesterImpl ( )

inlinevirtual

Definition at line 360 of file responseHandlers.h.

360 {}

Member Function Documentation

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

protected

Definition at line 1344 of file responseHandlers.cpp.

 {
     startRequest(QOS_INIT);
     shared_pointer thisPointer(shared_from_this());
     _channel->registerRequest(_ioid, thisPointer);
     INIT_EXCEPTION_GUARD(CMD_PUT, _channelPut, _channel->getChannel()->createChannelPut(thisPointer, pvRequest));
 }

void epics::pvAccess::ServerChannelPutRequesterImpl::channelPutConnect	(	const epics::pvData::Status &	status,
		ChannelPut::shared_pointer const &	channelPut,
		epics::pvData::Structure::const_shared_pointer const &	structure
	)

virtual

The client and server have both processed the createChannelPut request.

Parameters

status	Completion status.
channelPut	The channelPut interface or null if the request failed.
structure	The introspection interface of requested put/get structure or nullptr if the request failed.

Implements epics::pvAccess::ChannelPutRequester.

Definition at line 1352 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         _channelPut = channelPut;
         if (_status.isSuccess())
         {
             _pvStructure = std::tr1::static_pointer_cast<PVStructure>(reuseOrCreatePVField(structure, _pvStructure));
             _bitSet = createBitSetFor(_pvStructure, _bitSet);
         }
     }
 
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 
     // self-destruction
     if (!status.isSuccess())
     {
         destroy();
     }
 }

ChannelPutRequester::shared_pointer epics::pvAccess::ServerChannelPutRequesterImpl::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 1334 of file responseHandlers.cpp.

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

void epics::pvAccess::ServerChannelPutRequesterImpl::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

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

ChannelPut::shared_pointer epics::pvAccess::ServerChannelPutRequesterImpl::getChannelPut ( )

Definition at line 1422 of file responseHandlers.cpp.

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

void epics::pvAccess::ServerChannelPutRequesterImpl::getDone	(	const epics::pvData::Status &	status,
		ChannelPut::shared_pointer const &	channelPut,
		epics::pvData::PVStructure::shared_pointer const &	pvStructure,
		epics::pvData::BitSet::shared_pointer const &	bitSet
	)

virtual

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

Ownership transfer as with ChannelGetRequester::getDone()

Parameters

status	Completion status.
channelPut	The channelPut interface.
pvStructure	The PVStructure that holds the data or nullptr if the request failed.
bitSet	The bitSet for that shows what data has changed or nullptr if the request failed.

Implements epics::pvAccess::ChannelPutRequester.

Definition at line 1385 of file responseHandlers.cpp.

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

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

inlinevirtual

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

Implements epics::pvAccess::BaseChannelRequester.

Definition at line 370 of file responseHandlers.h.

370 { return getChannelPut(); }

epics::pvAccess::ServerChannelPutRequesterImpl::getChannelPut

ChannelPut::shared_pointer getChannelPut()

Definition: responseHandlers.cpp:1422

BitSet::shared_pointer epics::pvAccess::ServerChannelPutRequesterImpl::getPutBitSet ( )

Definition at line 1428 of file responseHandlers.cpp.

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

PVStructure::shared_pointer epics::pvAccess::ServerChannelPutRequesterImpl::getPutPVStructure ( )

Definition at line 1434 of file responseHandlers.cpp.

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

void epics::pvAccess::ServerChannelPutRequesterImpl::putDone	(	const epics::pvData::Status &	status,
		ChannelPut::shared_pointer const &	channelPut
	)

virtual

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

Parameters

status	Completion status.
channelPut	The channelPut interface.

Implements epics::pvAccess::ChannelPutRequester.

Definition at line 1375 of file responseHandlers.cpp.

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

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

 {
     const int32 request = getPendingRequest();
 
     ChannelPut::shared_pointer channelPut;
     {
         Lock guard(_mutex);
         channelPut = _channelPut;
         // we must respond to QOS_INIT (e.g. creation error)
         if (!channelPut && !(request & QOS_INIT))
             return;
     }
 
     control->startMessage((int32)CMD_PUT, 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(_pvStructure->getStructure(), buffer);
         }
         else if ((QOS_GET & request) != 0)
         {
             ScopedLock lock(channelPut);
             _bitSet->serialize(buffer, control);
             _pvStructure->serialize(buffer, control, _bitSet.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