Turi Create  4.0
cppipc::call_message Struct Reference

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

Public Member Functions

 call_message ()
 Default constructor.
 
bool construct (nanosockets::zmq_msg_vector &vec)
 
void emit (nanosockets::zmq_msg_vector &vec)
 
void clear ()
 Empties the message, freeing all contents.
 

Public Attributes

std::string function_name
 the object to call
 
std::map< std::string, std::string > properties
 the function to call on the object
 
nanosockets::nn_msg_t bodybuf
 Other properties.
 
const char * body
 
size_t bodylen
 The serialized arguments of the call. May point into bodybuf.
 
bool zmqbodyused
 The length of the body.
 

Detailed Description

The contents of the message used to call a function from the client to the server.

Definition at line 23 of file message_types.hpp.

Member Function Documentation

◆ construct()

bool cppipc::call_message::construct ( nanosockets::zmq_msg_vector &  vec)

constructs a call_message from a zmq_msg_vector. Will also, as a side effect, clear the zmq_msg_vector. Any existing contents in the call_message will be cleared. Returns true on success, false if the format is incorrect.

◆ emit()

void cppipc::call_message::emit ( nanosockets::zmq_msg_vector &  vec)

appends the message a zmq_msg_vector from a call message. Will also as a side effect, clear the contents of this call message.

Member Data Documentation

◆ body

const char* cppipc::call_message::body

When receiving, this will contain the actual contents of the body

Definition at line 51 of file message_types.hpp.


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