sapi_dual_msgchannel.c File Reference

"Channel" layer of ADR-020 - see sapi_dual_msgchannel.h. More...

#include "safeapi/redundancy/dual/sapi_dual_msgchannel.h"

Include dependency graph for sapi_dual_msgchannel.c:

Go to the source code of this file.

Functions
sapi_status_t	sapi_dual_msgchannel_init (sapi_dual_msgchannel_t *channel, const sapi_dual_msgchannel_config_t *config)
	Initializes a sapi_dual_msgchannel_t: starts both sequence counters at 0.
sapi_status_t	sapi_dual_msgchannel_send (sapi_dual_msgchannel_t *channel, const uint8_t *payload, uint8_t payload_size, sapi_duration_ms_t timeout_ms, uint32_t *out_sequence)
	Wraps payload in a sapi_vital_message_t (this channel's own sender_id and next sequence_number) and sends it over config->link, blocking at most timeout_ms.
sapi_status_t	sapi_dual_msgchannel_receive (sapi_dual_msgchannel_t *channel, uint8_t *out_payload, uint8_t payload_max_size, sapi_duration_ms_t timeout_ms, uint8_t *out_payload_size, uint32_t *out_sequence)
	Receives one frame over config->link, blocking at most timeout_ms, verifies its CRC-64 and sequence continuity (sapi_checksum_vital_message_verify() against channel->expected_sequence) and its sender_id against config->expected_peer_id, and extracts the payload.
sapi_status_t	sapi_dual_msgchannel_reset_sequence (sapi_dual_msgchannel_t *channel)
	Resets both sequence counters to 0. Intended to be called by the caller (typically sapi_dual_channel_t) exactly once, immediately after config->link has been freshly (re)established with the peer - mirrors safeAPIRBC2oo2's own precedent (channel_ab.c's cycle_resync_requested handling after a peer link reconnects) for why a fresh link needs a fresh, mutually agreed starting sequence rather than fighting over whatever counters were left over from before the disconnect.

Detailed Description

"Channel" layer of ADR-020 - see sapi_dual_msgchannel.h.

Definition in file sapi_dual_msgchannel.c.