Turi Create  4.0
cppipc::object_factory_proxy Class Reference

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

Public Member Functions

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

Detailed Description

Definition at line 19 of file object_factory_proxy.hpp.

Member Function Documentation

◆ delete_object()

void cppipc::object_factory_proxy::delete_object ( size_t  object_id)
inlinevirtual

Deletes the object refered to by an object ID

Implements cppipc::object_factory_base.

Definition at line 34 of file object_factory_proxy.hpp.

◆ get_control_address()

std::string cppipc::object_factory_proxy::get_control_address ( )
inlinevirtual

Get the address which the server is receiving control messages

Implements cppipc::object_factory_base.

Definition at line 42 of file object_factory_proxy.hpp.

◆ get_status_publish_address()

std::string cppipc::object_factory_proxy::get_status_publish_address ( )
inlinevirtual

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

Implements cppipc::object_factory_base.

Definition at line 38 of file object_factory_proxy.hpp.

◆ make_object()

size_t cppipc::object_factory_proxy::make_object ( std::string  objectname)
inlinevirtual

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

Implements cppipc::object_factory_base.

Definition at line 26 of file object_factory_proxy.hpp.

◆ ping()

std::string cppipc::object_factory_proxy::ping ( std::string  pingval)
inlinevirtual

Replies with the pingval.

Implements cppipc::object_factory_base.

Definition at line 30 of file object_factory_proxy.hpp.

◆ sync_objects()

void cppipc::object_factory_proxy::sync_objects ( std::vector< size_t >  object_ids,
bool  active_list 
)
inlinevirtual

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

Implements cppipc::object_factory_base.

Definition at line 46 of file object_factory_proxy.hpp.


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