sapi_voter.h

Go to the documentation of this file.

 
#ifndef SAPI_VOTER_H
#define SAPI_VOTER_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"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    SAPI_VOTING_2OO2 = 1,
    SAPI_VOTING_2OO3 = 2,
    SAPI_VOTING_NMR = 3
} sapi_voting_strategy_t;

typedef enum {
    SAPI_VOTING_AGREED = 0,
    SAPI_VOTING_DISAGREED = 1,
    SAPI_VOTING_TIMEOUT = 2,
    SAPI_VOTING_INSUFFICIENT_QUORUM = 3
} sapi_voting_result_t;

typedef bool (*sapi_voter_compare_fn)(const void *a, const void *b, size_t size, void *user_ctx);

typedef struct {
    sapi_voting_strategy_t voting_strategy;
    uint32_t quorum_size;
    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_voter_config_t;

#define SAPI_VOTER_MAX_CHANNELS 8U

#define SAPI_VOTER_MAX_MESSAGE_SIZE 256U

typedef struct {
    sapi_voter_config_t config;
    sapi_channel_t *channels[SAPI_VOTER_MAX_CHANNELS];
    uint32_t channel_count;
    uint32_t total_disagreements;
    bool initialized;
} sapi_voter_storage_t;

typedef sapi_voter_storage_t sapi_voter_t;

sapi_status_t sapi_voter_init(sapi_voter_storage_t *storage, const sapi_voter_config_t *config);

sapi_status_t sapi_voter_register_channel(sapi_voter_t *voter, sapi_channel_t *channel);

sapi_status_t sapi_voter_send(sapi_voter_t *voter, const void *data, size_t data_size);

sapi_status_t sapi_voter_receive(sapi_voter_t *voter, void *data, size_t data_size,
                                  sapi_voting_result_t *result, size_t *bytes_received);

sapi_status_t sapi_voter_get_aggregated_health(const sapi_voter_t *voter,
                                                uint32_t *healthy_count,
                                                uint32_t *total_disagreements);

uint32_t sapi_voter_get_channel_count(const sapi_voter_t *voter);

sapi_channel_t *sapi_voter_get_channel(const sapi_voter_t *voter, uint32_t index);

sapi_channel_t *sapi_voter_get_channel_by_name(const sapi_voter_t *voter, const char *name);

sapi_status_t sapi_voter_destroy(sapi_voter_t *voter);
 
#ifdef __cplusplus
}
#endif

 
#endif /* SAPI_VOTER_H */