#include "responseHandlers.h"

Inheritance diagram for epics::pvAccess::ServerChannelRPCRequesterImpl:

Collaboration diagram for epics::pvAccess::ServerChannelRPCRequesterImpl:

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

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

Public Types inherited from epics::pvAccess::ChannelRPCRequester
typedef ChannelRPC	operation_type

Public Member Functions
virtual	~ServerChannelRPCRequesterImpl ()

virtual void	channelRPCConnect (const epics::pvData::Status &status, ChannelRPC::shared_pointer const &channelRPC) OVERRIDE FINAL

virtual void	requestDone (const epics::pvData::Status &status, ChannelRPC::shared_pointer const &channelRPC, epics::pvData::PVStructure::shared_pointer const &pvResponse) OVERRIDE FINAL

virtual void	destroy () OVERRIDE FINAL

ChannelRPC::shared_pointer	getChannelRPC ()

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

virtual	~ChannelRPCRequester ()

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

	ChannelBaseRequester ()

virtual	~ChannelBaseRequester ()

virtual void	channelDisconnect (bool destroy)

Static Public Member Functions
static ChannelRPCRequester::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
	ServerChannelRPCRequesterImpl (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 759 of file responseHandlers.h.

Member Typedef Documentation

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

Definition at line 766 of file responseHandlers.h.

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

Definition at line 765 of file responseHandlers.h.

Constructor & Destructor Documentation

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

protected

Definition at line 2786 of file responseHandlers.cpp.

                                                                      :
     BaseChannelRequester(context, channel, ioid, transport),
     _channelRPC(), _pvResponse()
   ,_status(Status::fatal("Invalid State"))
 
 {
 }

virtual epics::pvAccess::ServerChannelRPCRequesterImpl::~ServerChannelRPCRequesterImpl ( )

inlinevirtual

Definition at line 776 of file responseHandlers.h.

776 {}

Member Function Documentation

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

protected

Definition at line 2806 of file responseHandlers.cpp.

 {
     startRequest(QOS_INIT);
     shared_pointer thisPointer(shared_from_this());
     _channel->registerRequest(_ioid, thisPointer);
     INIT_EXCEPTION_GUARD(CMD_RPC, _channelRPC, _channel->getChannel()->createChannelRPC(thisPointer, pvRequest));
 }

void epics::pvAccess::ServerChannelRPCRequesterImpl::channelRPCConnect	(	const epics::pvData::Status &	status,
		ChannelRPC::shared_pointer const &	operation
	)

virtual

RPC creation request satisfied.

Must check status.isOk().

On Success, a non-NULL 'operation' is provided. This is the same pointer which was, or will be, returned from Channel::createChannelRPC().

It is allowed to call ChannelRPC::request() from within this method.

Implements epics::pvAccess::ChannelRPCRequester.

Definition at line 2814 of file responseHandlers.cpp.

 {
     {
         Lock guard(_mutex);
         _status = status;
         _channelRPC = channelRPC;
     }
     TransportSender::shared_pointer thisSender = shared_from_this();
     _transport->enqueueSendRequest(thisSender);
 
     // self-destruction
     if (!status.isSuccess())
     {
         destroy();
     }
 }

ChannelRPCRequester::shared_pointer epics::pvAccess::ServerChannelRPCRequesterImpl::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 2796 of file responseHandlers.cpp.

 {
     // TODO use std::make_shared
     std::tr1::shared_ptr<ServerChannelRPCRequesterImpl> tp(new ServerChannelRPCRequesterImpl(context, channel, ioid, transport));
     tp->activate(pvRequest);
     return tp;
 }

void epics::pvAccess::ServerChannelRPCRequesterImpl::destroy ( )

virtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 2842 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());
 
     {
         Lock guard(_mutex);
         _channel->unregisterRequest(_ioid);
 
         if (_channelRPC.get())
         {
             _channelRPC->destroy();
         }
     }
     // TODO
     _channelRPC.reset();
 }

ChannelRPC::shared_pointer epics::pvAccess::ServerChannelRPCRequesterImpl::getChannelRPC ( )

Returns: the channelRPC

Definition at line 2862 of file responseHandlers.cpp.

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

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

inlinevirtual

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

Implements epics::pvAccess::BaseChannelRequester.

Definition at line 787 of file responseHandlers.h.

787 { return getChannelRPC(); }

epics::pvAccess::ServerChannelRPCRequesterImpl::getChannelRPC

ChannelRPC::shared_pointer getChannelRPC()

Definition: responseHandlers.cpp:2862

void epics::pvAccess::ServerChannelRPCRequesterImpl::requestDone	(	const epics::pvData::Status &	status,
		ChannelRPC::shared_pointer const &	operation,
		epics::pvData::PVStructure::shared_pointer const &	pvResponse
	)

virtual

RPC request (execution) completed.

Must check status.isOk().

On Success, a non-NULL 'pvResponse' is provided.

It is allowed to call ChannelRPC::request() from within this method.

Implements epics::pvAccess::ChannelRPCRequester.

Definition at line 2831 of file responseHandlers.cpp.

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

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

 {
     const int32 request = getPendingRequest();
 
     control->startMessage((int32)CMD_RPC, 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)
             {
                 // noop
             }
             else
             {
                 SerializationHelper::serializeStructureFull(buffer, control, _pvResponse);
             }
         }
         _status = Status::fatal("Stale state");
     }
 
     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