sapi_cross_comparator.h

Go to the documentation of this file.

 
#ifndef SAPI_CROSS_COMPARATOR_H
#define SAPI_CROSS_COMPARATOR_H
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/redundancy/channel_link/sapi_channel.h"
#include "safeapi/redundancy/voter/sapi_voter.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct {
    uint32_t channel_timeout_ms;
    sapi_voter_compare_fn compare;
    void *compare_context;
    bool log_disagreements;
    bool trigger_safestate_on_disagreement;
    void (*on_disagreement)(void *context, sapi_voting_result_t result);
    void *disagreement_context;
} sapi_cross_comparator_config_t;

#define SAPI_CROSS_COMPARATOR_MAX_MESSAGE_SIZE 256U

typedef struct {
    sapi_cross_comparator_config_t config;
    sapi_channel_t *channel_a;
    sapi_channel_t *channel_b;
    uint32_t registered_count;
    uint32_t total_disagreements;
    bool initialized;
} sapi_cross_comparator_storage_t;

typedef sapi_cross_comparator_storage_t sapi_cross_comparator_t;

sapi_status_t sapi_cross_comparator_init(sapi_cross_comparator_storage_t *storage,
                                          const sapi_cross_comparator_config_t *config);

sapi_status_t sapi_cross_comparator_register_channel(sapi_cross_comparator_t *cmp,
                                                      sapi_channel_t *channel);

sapi_status_t sapi_cross_comparator_execute(sapi_cross_comparator_t *cmp, size_t data_size,
                                             sapi_voting_result_t *result,
                                             void *out_data, size_t *out_size);

sapi_status_t sapi_cross_comparator_get_aggregated_health(const sapi_cross_comparator_t *cmp,
                                                           uint32_t *healthy_count,
                                                           uint32_t *total_disagreements);

sapi_status_t sapi_cross_comparator_destroy(sapi_cross_comparator_t *cmp);
 
#ifdef __cplusplus
}
#endif

 
#endif /* SAPI_CROSS_COMPARATOR_H */