YAMI4 - C++ general-purpose interface
yami Namespace Reference

Namespace devoted to everything related to YAMI4.

Classes

class  activity_statistics_monitor
 Simple activity statistics monitor. More...
class  agent
 Message broker. More...
class  yami_logic_error
 General exception class for reporting logic errors. More...
class  yami_runtime_error
 General exception class for reporting run-time errors. More...
class  event_callback
 Event notification callback interface. More...
class  incoming_message
 Incoming message. More...
class  outgoing_message
 Outgoing message. More...
class  parameter_entry
 Read-only view on the parameters entry. More...
class  parameters
 Collection of message parameters. More...
class  raw_buffer_data_source
 Serializable wrapper for the raw binary data. More...
class  serializable
 Common interface for serializable data source. More...
class  value_publisher
 Simple subscription publisher. More...

Enumerations

enum  connection_event { new_incoming_connection, new_outgoing_connection, connection_closed }
 Kind of connection event. More...
enum  message_state {
  posted, transmitted, abandoned, replied,
  rejected
}
 Outgoing message state. More...
enum  parameter_type {
  unused, boolean, integer, long_long,
  double_float, string, binary, boolean_array,
  integer_array, long_long_array, double_float_array, string_array,
  binary_array, nested_parameters, nested_parameters_array
}
 Type of parameter entry. More...
enum  value_publisher_overflow_action { wait_for_previous_message, abandon_message, abandon_subscription }
 User-defined reaction to the overflow condition in value publisher. More...

Variables

const char *const version_name = "1.10.0"
 Library version name.
const int version_number = 11000
 Library version number (X * 10000 + Y * 100 + Z).

Enumeration Type Documentation

Enumerator:
new_incoming_connection 

New incoming connection was created.

new_outgoing_connection 

New outgoing connection was created.

connection_closed 

Connection was closed.

Enumerator:
posted 

Message was posted for transmission.

transmitted 

Message was fully transmitted.

abandoned 

Message was abandoned due to error or channel closing.

replied 

The reply was received for the given message.

rejected 

Message was rejected.

Enumerator:
unused 

Internal mark for unused slots.

boolean 

bool

integer 

int

long_long 

long long

double_float 

double

string 

string

binary 

Binary block.

boolean_array 

Array of bool.

integer_array 

Array of int.

long_long_array 

Array of long long.

double_float_array 

Array of double.

string_array 

Array of strings.

binary_array 

Array of binary blocks.

nested_parameters 

Nested parameters object.

nested_parameters_array 

Array of nested parameters object.

Enumerator:
wait_for_previous_message 

block and wait until previous message is transmitted

abandon_message 

abandon the current message and continue with other subscribers

abandon_subscription 

abandon the overflowing subscription altogether and continue with other subscribers