Latency measurement for timed/scheduled messages.
[Examples]

Example code for measuring message latency between components. More...

Modules
	Application Components
	Application components.
Defines
#define	LATENCY_CHANNELS__COMMAND   "lcc"
#define	LATENCY_CHANNELS__DATA   "ldc"
#define	LATENCY_CHANNELS__RESPONSE   "lrc"
#define	LATENCY_CHANNELS__REPORT   "ldrc"
Enumerations
enum	module_latency_messages_command_fields {   LATENCY_CMD_FIELD__TYPE = 0, LATENCY_CMD_FIELD__PARAM = 1, LATENCY_CMD_FIELD__VALUE = 2, LATENCY_CMD_FIELD__ADDRESS = 3,   LATENCY_CMD_FIELD__GROUP = 4 }
	Enumeration of fields that occur in a timed latency message. More...
enum	module_latency_messages_command_fields_type_values {   LATENCY_CMD__START_EXECUTION, LATENCY_CMD__STOP_EXECUTION, LATENCY_CMD__UPDATE_PARAM, LATENCY_CMD__JOIN_REQUEST,   LATENCY_CMD__JOIN, LATENCY_CMD__JOIN_ACK }
	Enumeration of the possible commands used in timed latency messages. More...
enum	module_latency_messages_data_fields { LATENCY_DATA_FIELD__SEND_TIME = 0, LATENCY_DATA_FIELD__PAYLOAD = 1, LATENCY_DATA_FIELD__ADDRESS = 2, LATENCY_DATA_FIELD__GROUP = 3 }
	Enumeration of the fields in a data message. More...
enum	module_latency_messages_data_report_fields { LATENCY_DATA_REPORT_FIELD__ADDRESS = 0, LATENCY_DATA_REPORT_FIELD__GROUP = 1, LATENCY_DATA_REPORT_FIELD__TX_TIMES = 2, LATENCY_DATA_REPORT_FIELD__RX_TIMES = 3 }
	Enumeration of fields in data reporting message.
enum	module_latency_messsages_command_fields_param_values { LATENCY_CMD_PARAM__INTERVAL_MS, LATENCY_CMD_PARAM__PARAM_BENCHMARK_DURATION_S, LATENCY_CMD_PARAM__DATA_LENGTH_BYTES, LATENCY_CMD_PARAM__JOIN_REQUEST_ID }
	Enumaration of the possible parameters that can be used in timed latency messages. More...

---

Detailed Description

Example code for measuring message latency between components.

Contains application components for sending and receiving a series of timed messages at a regular interval, as well as managing their configuration and reporting results.

---

Enumeration Type Documentation

enum module_latency_messages_command_fields

Enumeration of fields that occur in a timed latency message.

Enumerator:

LATENCY_CMD_FIELD__TYPE	Message field containing a command. For a list of possible commands, see command_message_commands
LATENCY_CMD_FIELD__PARAM	Message field containing a parameter identifier. For a list of possible parameters see command_message_params
LATENCY_CMD_FIELD__VALUE	Message field containing a parameter value.
LATENCY_CMD_FIELD__ADDRESS	Identifier of the specific component the message is addressed to (if applicable). While this field will always be defined, a type indicates that the message is intended for all receivers
LATENCY_CMD_FIELD__GROUP	Identifier of the specific group this message is directed to.

Definition at line 23 of file timed_latency.h.

enum module_latency_messages_command_fields_type_values

Enumeration of the possible commands used in timed latency messages.

Enumerator:

LATENCY_CMD__START_EXECUTION	Command to start execution of the timed latency test.
LATENCY_CMD__UPDATE_PARAM	Command to update a parameter of the timed latency test.
LATENCY_CMD__JOIN_REQUEST	Request for a listener to join the experiment.
LATENCY_CMD__JOIN	Response for a listener to join the experiment with the given identifier.
LATENCY_CMD__JOIN_ACK	Join acknowledgement.

Definition at line 49 of file timed_latency.h.

enum module_latency_messages_data_fields

Enumeration of the fields in a data message.

Enumerator:

LATENCY_DATA_FIELD__SEND_TIME	Timestamp of when the message was intended to be sent.
LATENCY_DATA_FIELD__PAYLOAD	Payload content of the message.
LATENCY_DATA_FIELD__ADDRESS	Address of the sender.
LATENCY_DATA_FIELD__GROUP	Group of the sender.

Definition at line 71 of file timed_latency.h.

enum module_latency_messsages_command_fields_param_values

Enumaration of the possible parameters that can be used in timed latency messages.

Enumerator:

LATENCY_CMD_PARAM__INTERVAL_MS	Message interval, in milliseconds.
LATENCY_CMD_PARAM__PARAM_BENCHMARK_DURATION_S	Duration of the latency benchmark, in seconds.
LATENCY_CMD_PARAM__DATA_LENGTH_BYTES	Length of the message payload used in the latency test, in bytes.
LATENCY_CMD_PARAM__JOIN_REQUEST_ID	Uniquely identifies a join request.

Definition at line 95 of file timed_latency.h.

---