Caffa  1.1.0
C++ Application Framework for Embedded Systems with introspection
Public Member Functions | List of all members
caffa::rpc::Client Class Referenceabstract
Inheritance diagram for caffa::rpc::Client:
Inheritance graph
[legend]

Public Member Functions

 Client (const std::string &hostname, int port)
 
virtual caffa::AppInfo appInfo () const =0
 
virtual std::shared_ptr< caffa::ObjectHandledocument (const std::string &documentId) const =0
 
virtual std::vector< std::shared_ptr< caffa::ObjectHandle > > documents () const =0
 
virtual std::string execute (caffa::not_null< const caffa::ObjectHandle * > selfObject, const std::string &methodName, const std::string &jsonArguments) const =0
 
virtual bool stopServer ()=0
 
virtual void sendKeepAlive ()=0
 
virtual caffa::Session::Type checkSession () const =0
 Check the session. Will return a session type (including possibly INVALID) if the session exists. And throw an exception if it does not. More...
 
virtual void changeSession (caffa::Session::Type newType)=0
 
virtual void destroySession ()=0
 
virtual const std::string & sessionUuid () const =0
 
virtual void startKeepAliveThread ()=0
 
template<typename DataType >
void set (const caffa::ObjectHandle *objectHandle, const std::string &fieldName, const DataType &value)
 Set a value through RPC.
 
template<typename DataType >
DataType get (const caffa::ObjectHandle *objectHandle, const std::string &fieldName) const
 Get a value through RPC.
 
virtual std::shared_ptr< caffa::ObjectHandlegetShallowCopyOfChildObject (const caffa::ObjectHandle *objectHandle, const std::string &fieldName) const =0
 
virtual std::shared_ptr< caffa::ObjectHandlegetDeepCopyOfChildObject (const caffa::ObjectHandle *objectHandle, const std::string &fieldName) const =0
 
virtual void deepCopyChildObjectFrom (const caffa::ObjectHandle *objectHandle, const std::string &fieldName, const caffa::ObjectHandle *childObject)=0
 
virtual std::vector< std::shared_ptr< caffa::ObjectHandle > > getChildObjects (const caffa::ObjectHandle *objectHandle, const std::string &fieldName) const =0
 
virtual void setChildObject (const caffa::ObjectHandle *objectHandle, const std::string &fieldName, const caffa::ObjectHandle *childObject)=0
 
virtual void removeChildObject (const caffa::ObjectHandle *objectHandle, const std::string &fieldName, size_t index)=0
 
virtual void clearChildObjects (const caffa::ObjectHandle *objectHandle, const std::string &fieldName)=0
 
virtual void insertChildObject (const caffa::ObjectHandle *objectHandle, const std::string &fieldName, size_t index, const caffa::ObjectHandle *childObject)=0
 
const std::string & hostname () const
 
int port () const
 

Member Function Documentation

◆ checkSession()

virtual caffa::Session::Type caffa::rpc::Client::checkSession ( ) const
pure virtual

Check the session. Will return a session type (including possibly INVALID) if the session exists. And throw an exception if it does not.

Returns
caffa::Session::Type

Implemented in caffa::rpc::RestClient.


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