epics::pvAccess::ChannelRPCServiceImpl Class Reference

Inheritance diagram for epics::pvAccess::ChannelRPCServiceImpl:

Collaboration diagram for epics::pvAccess::ChannelRPCServiceImpl:

Public Member Functions
	ChannelRPCServiceImpl (Channel::shared_pointer const &channel, ChannelRPCRequester::shared_pointer const &channelRPCRequester, RPCServiceAsync::shared_pointer const &rpcService)
virtual	~ChannelRPCServiceImpl ()
virtual void	requestDone (epics::pvData::Status const &status, epics::pvData::PVStructure::shared_pointer const &result)
virtual void	request (epics::pvData::PVStructure::shared_pointer const &pvArgument)
void	lastRequest ()
virtual Channel::shared_pointer	getChannel ()
virtual void	cancel ()
virtual void	destroy ()
Public Member Functions inherited from epics::pvAccess::ChannelRPC
	POINTER_DEFINITIONS (ChannelRPC)
virtual	~ChannelRPC ()
Public Member Functions inherited from epics::pvAccess::ChannelRequest
	POINTER_DEFINITIONS (ChannelRequest)
	ChannelRequest ()
virtual	~ChannelRequest ()
Public Member Functions inherited from epics::pvAccess::Destroyable
	POINTER_DEFINITIONS (Destroyable)
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::RPCResponseCallback
	POINTER_DEFINITIONS (RPCResponseCallback)
virtual	~RPCResponseCallback ()

Additional Inherited Members
Public Types inherited from epics::pvAccess::ChannelRPC
typedef ChannelRPCRequester	requester_type
Static Public Attributes inherited from epics::pvAccess::ChannelRequest
static size_t	num_instances
Protected Member Functions inherited from epics::pvAccess::Destroyable
virtual	~Destroyable ()

Detailed Description

Definition at line 23 of file rpcServer.cpp.

Constructor & Destructor Documentation

epics::pvAccess::ChannelRPCServiceImpl::ChannelRPCServiceImpl ( Channel::shared_pointer const &  channel, ChannelRPCRequester::shared_pointer const &  channelRPCRequester, RPCServiceAsync::shared_pointer const &  rpcService  )

inline

Definition at line 35 of file rpcServer.cpp.

                                                          :
        m_channel(channel),
        m_channelRPCRequester(channelRPCRequester),
        m_rpcService(rpcService),
        m_lastRequest()
    {
    }

virtual epics::pvAccess::ChannelRPCServiceImpl::~ChannelRPCServiceImpl ( )

inlinevirtual

Definition at line 46 of file rpcServer.cpp.

    {
        destroy();
    }

Member Function Documentation

virtual void epics::pvAccess::ChannelRPCServiceImpl::cancel ( )

inlinevirtual

Cancel any pending request. Completion will be reported via request's response callback:

• if cancel() request is issued after the request was already complete, request success/failure completion will be reported and cancel() request ignored.
• if the request was actually canceled, cancellation completion is reported.

Implements epics::pvAccess::ChannelRequest.

Definition at line 103 of file rpcServer.cpp.

    {
        // noop
    }

virtual void epics::pvAccess::ChannelRPCServiceImpl::destroy ( )

inlinevirtual

Destroy this instance.

Implements epics::pvAccess::Destroyable.

Definition at line 108 of file rpcServer.cpp.

    {
        // noop
    }

virtual Channel::shared_pointer epics::pvAccess::ChannelRPCServiceImpl::getChannel ( )

inlinevirtual

Get a channel instance this request belongs to.

Returns

the channel instance.

Implements epics::pvAccess::ChannelRequest.

Definition at line 98 of file rpcServer.cpp.

    {
        return m_channel;
    }

void epics::pvAccess::ChannelRPCServiceImpl::lastRequest ( )

inlinevirtual

Announce next request as last request. When last request will be completed (regardless of completion status) the remote and local instance will be destroyed.

Implements epics::pvAccess::ChannelRequest.

Definition at line 93 of file rpcServer.cpp.

    {
        m_lastRequest.set();
    }

virtual void epics::pvAccess::ChannelRPCServiceImpl::request ( epics::pvData::PVStructure::shared_pointer const &  pvArgument )

inlinevirtual

Issue an RPC request to the channel.

Completion status is reported by calling ChannelRPCRequester::requestDone() callback, which may be called from this method.

Precondition

The underlying Channel must be connected, and this ChannelRPC valid. Otherwise the ChannelRPCRequester::requestDone() is called with an error.

Postcondition

After calling request(), the requestDone() callback will be called at some later time. May call ChannelRPC::cancel() to request to abort() this operation.

Parameters

pvArgument

The argument structure for an RPC request.

Implements epics::pvAccess::ChannelRPC.

Definition at line 62 of file rpcServer.cpp.

    {
        try
        {
            m_rpcService->request(pvArgument, shared_from_this());
        }
        catch (std::exception& ex)
        {
            // handle user unexpected errors
            Status errorStatus(Status::STATUSTYPE_FATAL, ex.what());

            m_channelRPCRequester->requestDone(errorStatus, shared_from_this(), PVStructure::shared_pointer());

            if (m_lastRequest.get())
                destroy();
        }
        catch (...)
        {
            // handle user unexpected errors
            Status errorStatus(Status::STATUSTYPE_FATAL,
                               "Unexpected exception caught while calling RPCServiceAsync.request(PVStructure, RPCResponseCallback).");

            m_channelRPCRequester->requestDone(errorStatus, shared_from_this(), PVStructure::shared_pointer());

            if (m_lastRequest.get())
                destroy();
        }

        // we wait for callback to be called
    }

virtual void epics::pvAccess::ChannelRPCServiceImpl::requestDone ( epics::pvData::Status const &  status, epics::pvData::PVStructure::shared_pointer const &  result  )

inlinevirtual

Implements epics::pvAccess::RPCResponseCallback.

Definition at line 51 of file rpcServer.cpp.

    {
        m_channelRPCRequester->requestDone(status, shared_from_this(), result);

        if (m_lastRequest.get())
            destroy();
    }

---

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

• modules/pvAccess/src/rpcService/rpcServer.cpp