Turi Create  4.0
cppipc::object_factory_base Class Referenceabstract

#include <core/system/cppipc/common/object_factory_base.hpp>

Public Member Functions

virtual size_t make_object (std::string objectname)=0
 
virtual std::string ping (std::string pingval)=0
 
virtual void delete_object (size_t object_id)=0
 
virtual std::string get_status_publish_address ()=0
 
virtual std::string get_control_address ()=0
 
virtual void sync_objects (std::vector< size_t > object_ids, bool active_list)=0
 

Detailed Description

The object factory is the root object and has special powers.

Definition at line 20 of file object_factory_base.hpp.

Member Function Documentation

◆ delete_object()

virtual void cppipc::object_factory_base::delete_object ( size_t  object_id)
pure virtual

Deletes the object refered to by an object ID

Implemented in cppipc::object_factory_impl, and cppipc::object_factory_proxy.

◆ get_control_address()

virtual std::string cppipc::object_factory_base::get_control_address ( )
pure virtual

Get the address which the server is receiving control messages

Implemented in cppipc::object_factory_impl, and cppipc::object_factory_proxy.

◆ get_status_publish_address()

virtual std::string cppipc::object_factory_base::get_status_publish_address ( )
pure virtual

Get the address on which the server is publishing status updates.

Implemented in cppipc::object_factory_impl, and cppipc::object_factory_proxy.

◆ make_object()

virtual size_t cppipc::object_factory_base::make_object ( std::string  objectname)
pure virtual

Creates an object with type "objectname" on the server and returns the object ID of the object

Implemented in cppipc::object_factory_impl, and cppipc::object_factory_proxy.

◆ ping()

virtual std::string cppipc::object_factory_base::ping ( std::string  pingval)
pure virtual

Replies with the pingval.

Implemented in cppipc::object_factory_impl, and cppipc::object_factory_proxy.

◆ sync_objects()

virtual void cppipc::object_factory_base::sync_objects ( std::vector< size_t >  object_ids,
bool  active_list 
)
pure virtual

Takes a list of active objects on the client side and garbage collects the objects on the server that are now unused by the client.

If active_list is true, the object_ids refer to the list of objects that are still active: in other words, the server should delete any objects that are not in the active_list.

If active_list is false, the object_ids refer to the list of objects that are no longer active: in other words, the server should delete any objects that are in the active list

Implemented in cppipc::object_factory_impl, and cppipc::object_factory_proxy.


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