#include "responseHandlers.h"

Inheritance diagram for epics::pvAccess::ServerChannelGetRequesterImpl:

Collaboration diagram for epics::pvAccess::ServerChannelGetRequesterImpl:

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

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

Public Types inherited from epics::pvAccess::ChannelGetRequester
typedef ChannelGet	operation_type

Public Member Functions
virtual	~ServerChannelGetRequesterImpl ()

virtual void	channelGetConnect (const epics::pvData::Status &status, ChannelGet::shared_pointer const &channelGet, epics::pvData::Structure::const_shared_pointer const &structure) OVERRIDE FINAL

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

virtual void	destroy () OVERRIDE FINAL

ChannelGet::shared_pointer	getChannelGet ()

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...

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

virtual	~ChannelGetRequester ()

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

	ChannelBaseRequester ()

virtual	~ChannelBaseRequester ()

virtual void	channelDisconnect (bool destroy)

Static Public Member Functions
static ChannelGetRequester::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
	ServerChannelGetRequesterImpl (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 286 of file responseHandlers.h.

Member Typedef Documentation

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

Definition at line 293 of file responseHandlers.h.

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

Definition at line 292 of file responseHandlers.h.

Constructor & Destructor Documentation

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

protected

Definition at line 1099 of file responseHandlers.cpp.

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

virtual epics::pvAccess::ServerChannelGetRequesterImpl::~ServerChannelGetRequesterImpl ( )

inlinevirtual

Definition at line 304 of file responseHandlers.h.

304 {}

Member Function Documentation

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

protected

Definition at line 1115 of file responseHandlers.cpp.

 {
     startRequest(QOS_INIT);
     shared_pointer thisPointer(shared_from_this());
     _channel->registerRequest(_ioid, thisPointer);
     INIT_EXCEPTION_GUARD(CMD_GET, _channelGet, _channel->getChannel()->createChannelGet(thisPointer, pvRequest));
 }

void epics::pvAccess::ServerChannelGetRequesterImpl::channelGetConnect	(	const epics::pvData::Status &	status,
		ChannelGet::shared_pointer const &	channelGet,
		epics::pvData::Structure::const_shared_pointer const &	structure
	)

virtual

The client and server have both completed the createChannelGet request.

Parameters

status	Completion status.
channelGet	The channelGet interface or nullptr if the request failed.
structure	The introspection interface of requested get structure or nullptr if the request failed.

Implements epics::pvAccess::ChannelGetRequester.

Definition at line 1123 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         _channelGet = channelGet;
 
         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();
     }
 }

ChannelGetRequester::shared_pointer epics::pvAccess::ServerChannelGetRequesterImpl::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 1105 of file responseHandlers.cpp.

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

void epics::pvAccess::ServerChannelGetRequesterImpl::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

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

ChannelGet::shared_pointer epics::pvAccess::ServerChannelGetRequesterImpl::getChannelGet ( )

Definition at line 1186 of file responseHandlers.cpp.

 {
     return _channelGet;
 }

void epics::pvAccess::ServerChannelGetRequesterImpl::getDone	(	const epics::pvData::Status &	status,
		ChannelGet::shared_pointer const &	channelGet,
		epics::pvData::PVStructure::shared_pointer const &	pvStructure,
		epics::pvData::BitSet::shared_pointer const &	bitSet
	)

virtual

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

Ownership of the PVStructure is passed to the ChannelGetRequester until a subsequent call to ChannelGet::get() or ChannelGetRequester::channelDisconnect()

Parameters

status	Completion status.
channelGet	The channelGet 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::ChannelGetRequester.

Definition at line 1147 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::ServerChannelGetRequesterImpl::getOperation ( )

inlinevirtual

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

Implements epics::pvAccess::BaseChannelRequester.

Definition at line 313 of file responseHandlers.h.

313 { return getChannelGet(); }

epics::pvAccess::ServerChannelGetRequesterImpl::getChannelGet

ChannelGet::shared_pointer getChannelGet()

Definition: responseHandlers.cpp:1186

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

 {
     const int32 request = getPendingRequest();
 
     ChannelGet::shared_pointer channelGet;
     {
         Lock guard(_mutex);
         channelGet = _channelGet;
         // we must respond to QOS_INIT (e.g. creation error)
         if (!channelGet && !(request & QOS_INIT))
             return;
     }
 
     control->startMessage((int8)CMD_GET, sizeof(int32)/sizeof(int8) + 1);
     buffer->putInt(_ioid);
     buffer->put((int8)request);
     {
         Lock guard(_mutex);
         _status.serialize(buffer, control);
     }
 
     // TODO !!!
     // if we call stopRequest() below (the second one, commented out), we might be too late
     // since between last serialization data and stopRequest() a buffer can be already flushed
     // (i.e. in case of directSerialize)
     // if we call it here, then a bad client can issue another request just after stopRequest() was called
     stopRequest();
 
     if (_status.isSuccess())
     {
         if (request & QOS_INIT)
         {
             Lock guard(_mutex);
             control->cachedSerialize(_pvStructure->getStructure(), buffer);
         }
         else
         {
             ScopedLock lock(channelGet);
 
             _bitSet->serialize(buffer, control);
             _pvStructure->serialize(buffer, control, _bitSet.get());
         }
     }
 
     //stopRequest();
 
     // lastRequest
     if (request & QOS_DESTROY)
     {
         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