kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass > Class Template Reference

Implementation of the RPC caller that represents a given network message class type. More...

#include <rpc_call.hpp>

Inheritance diagram for kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >:

Public Member Functions
const MessageClass *	getMessage () const
	Retrieves the cached network message that contains the arguments for this call.
virtual shared_ptr< GenericRPCReplyMessage >	getReturnValue () const
	Retrieve the return value of the RPC call.
virtual string	getType () const
	Return the type of the caller class, extracted from the template message class.
	RPCCall (InterfaceClass *interfaceClass, SessionClass *session)
	Constructor.
virtual void	setArguments (const MessagePackage &message)
	See AbstractRPCCall::setArguments.
virtual	~RPCCall ()
	Destructor.
Public Member Functions inherited from kanzi::connect::AbstractRPCCall
	AbstractRPCCall ()
	Constructor.
virtual void	execute ()=0
	Executes the function call with given arguments.
virtual	~AbstractRPCCall ()
	Destructor.

Static Public Member Functions
static string	Type ()
	Return the type of the caller class, extracted from the template message class.

Protected Member Functions
void	setReturnValue (shared_ptr< GenericRPCReplyMessage > value)
	Sets the return value.

Protected Attributes
InterfaceClass *	m_interface
	Connected interface.
const MessageClass *	m_message
	Cached message arguments.
shared_ptr< GenericRPCReplyMessage >	m_returnValue
	Return value from the.
SessionClass *	m_session
	Session that initiated the RPC call.

Detailed Description

template<class InterfaceClass, class SessionClass, class MessageClass>
class kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >

Implementation of the RPC caller that represents a given network message class type.

Constructor & Destructor Documentation

RPCCall()

template<class InterfaceClass , class SessionClass , class MessageClass >

kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::RPCCall ( InterfaceClass * interfaceClass, SessionClass * session )

inline

Constructor.

Parameters

interfaceClass	Interface to call when call is executed.
session	Session that initiated the call.

~RPCCall()

template<class InterfaceClass , class SessionClass , class MessageClass >

virtual kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::~RPCCall ( )

inlinevirtual

Destructor.

Member Function Documentation

getMessage()

template<class InterfaceClass , class SessionClass , class MessageClass >

const MessageClass * kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::getMessage ( ) const

inline

Retrieves the cached network message that contains the arguments for this call.

Returns

Network message that contains the arguments for this call.

getReturnValue()

template<class InterfaceClass , class SessionClass , class MessageClass >

virtual shared_ptr< GenericRPCReplyMessage > kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::getReturnValue ( ) const

inlinevirtual

Retrieve the return value of the RPC call.

Returns

return value.

Reimplemented from kanzi::connect::AbstractRPCCall.

getType()

template<class InterfaceClass , class SessionClass , class MessageClass >

virtual string kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::getType ( ) const

inlinevirtual

Return the type of the caller class, extracted from the template message class.

Returns

Type of the caller class.

Implements kanzi::connect::AbstractRPCCall.

setArguments()

template<class InterfaceClass , class SessionClass , class MessageClass >

virtual void kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::setArguments ( const MessagePackage & message )

inlinevirtual

See AbstractRPCCall::setArguments.

Implements kanzi::connect::AbstractRPCCall.

setReturnValue()

template<class InterfaceClass , class SessionClass , class MessageClass >

void kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::setReturnValue ( shared_ptr< GenericRPCReplyMessage > value )

inlineprotected

Sets the return value.

Type()

template<class InterfaceClass , class SessionClass , class MessageClass >

static string kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::Type ( )

inlinestatic

Return the type of the caller class, extracted from the template message class.

Returns

Type of the caller class.

Member Data Documentation

m_interface

template<class InterfaceClass , class SessionClass , class MessageClass >

InterfaceClass* kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::m_interface

protected

Connected interface.

m_message

template<class InterfaceClass , class SessionClass , class MessageClass >

const MessageClass* kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::m_message

protected

Cached message arguments.

m_returnValue

template<class InterfaceClass , class SessionClass , class MessageClass >

shared_ptr<GenericRPCReplyMessage> kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::m_returnValue

protected

Return value from the.

m_session

template<class InterfaceClass , class SessionClass , class MessageClass >

SessionClass* kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >::m_session

protected

Session that initiated the RPC call.

---

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

• connect/interface/rpc_call.hpp