Kanzi Connect  3.9.8
Kanzi Connect C++ API
kanzi::connect::AbstractRPCCall Class Referenceabstract

An abstract class that translates network message to interface function call. More...

#include <rpc_call.hpp>

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

Public Member Functions

 AbstractRPCCall ()
 Constructor. More...
 
virtual void execute ()=0
 Executes the function call with given arguments. More...
 
virtual shared_ptr< GenericRPCReplyMessage > getReturnValue () const
 Holds the function return value if any. More...
 
virtual string getType () const =0
 Returns type of the function, usually name of the function. More...
 
virtual void setArguments (const MessagePackage &message)=0
 Sets arguments of the function call from network message. More...
 
virtual ~AbstractRPCCall ()
 Destructor. More...
 

Detailed Description

An abstract class that translates network message to interface function call.

Constructor & Destructor Documentation

◆ AbstractRPCCall()

kanzi::connect::AbstractRPCCall::AbstractRPCCall ( )
inline

Constructor.

◆ ~AbstractRPCCall()

virtual kanzi::connect::AbstractRPCCall::~AbstractRPCCall ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ execute()

virtual void kanzi::connect::AbstractRPCCall::execute ( )
pure virtual

Executes the function call with given arguments.

◆ getReturnValue()

virtual shared_ptr<GenericRPCReplyMessage> kanzi::connect::AbstractRPCCall::getReturnValue ( ) const
inlinevirtual

Holds the function return value if any.

Returns
shared pointer to reply message that encapsulates the return value as whole.

Reimplemented in kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >.

◆ getType()

virtual string kanzi::connect::AbstractRPCCall::getType ( ) const
pure virtual

Returns type of the function, usually name of the function.

Returns
Type of the function, as string.

Implemented in kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >.

◆ setArguments()

virtual void kanzi::connect::AbstractRPCCall::setArguments ( const MessagePackage message)
pure virtual

Sets arguments of the function call from network message.

Parameters
messageNetwork message that has the arguments for the function call.

Implemented in kanzi::connect::RPCCall< InterfaceClass, SessionClass, MessageClass >.


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