sapi_safechannel.h

Go to the documentation of this file.

#ifndef SAPI_SAFECHANNEL_H
#define SAPI_SAFECHANNEL_H
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
#include "safeapi/redundancy/dual/sapi_dual_channel.h"
#include "safeapi/oal/netlink/sapi_netlink.h"
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
#include "safeapi/redundancy/channel_link/sapi_channel.h"
#include "safeapi/redundancy/voter/sapi_voter.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define SAPI_SAFECHANNEL_MAX_LINKS 4U

typedef enum sapi_safechannel_type_e
{
    SAPI_SAFECHANNEL_TYPE_DUAL_REDUNDANT = 0,
    SAPI_SAFECHANNEL_TYPE_VITAL_VOTED = 1
} sapi_safechannel_type_t;

typedef enum sapi_safechannel_link_status_e
{
    SAPI_SAFECHANNEL_LINK_DOWN     = 0, 
    SAPI_SAFECHANNEL_LINK_DEGRADED = 1, 
    SAPI_SAFECHANNEL_LINK_FULL     = 2  
} sapi_safechannel_link_status_t;

typedef struct sapi_safechannel_endpoint_s
{
    sapi_netlink_role_t role;
    const char *host;
    uint16_t port;
} sapi_safechannel_endpoint_t;

typedef struct sapi_safechannel_dual_config_s
{
    sapi_safechannel_endpoint_t endpoints[SAPI_SAFECHANNEL_MAX_LINKS];
    uint32_t link_count;
    uint32_t sender_id;
    uint32_t expected_peer_id;
    sapi_duration_ms_t connect_timeout_ms;
    sapi_duration_ms_t ack_timeout_ms;
    sapi_dual_channel_status_callback_t status_callback;
    void *status_callback_ctx;
} sapi_safechannel_dual_config_t;

typedef struct sapi_safechannel_vital_config_s
{
    sapi_safechannel_endpoint_t endpoints[SAPI_SAFECHANNEL_MAX_LINKS];
    uint32_t link_count;
    size_t message_size;
    sapi_voting_strategy_t voting_strategy;
    uint32_t quorum_size;
    sapi_duration_ms_t connect_timeout_ms;
    sapi_duration_ms_t channel_timeout_ms;
    bool log_disagreements;
    void (*on_disagreement)(void *context, sapi_voting_result_t result);
    void *context;
} sapi_safechannel_vital_config_t;

typedef struct sapi_safechannel_config_s
{
    sapi_safechannel_type_t type;
    union
    {
        sapi_safechannel_dual_config_t  dual;
        sapi_safechannel_vital_config_t vital;
    } as;
} sapi_safechannel_config_t;

typedef struct sapi_safechannel_s
{
    sapi_safechannel_type_t type;
    bool                    is_open;

    sapi_netlink_storage_t links[SAPI_SAFECHANNEL_MAX_LINKS];
    sapi_netlink_handle_t  link_handles[SAPI_SAFECHANNEL_MAX_LINKS];
    uint32_t                link_count;
 
    union
    {
        sapi_dual_channel_t dual;
        struct
        {
            sapi_channel_t channels[SAPI_SAFECHANNEL_MAX_LINKS];
            sapi_voter_t         voter;
        } vital;
    } impl;
} sapi_safechannel_t;

sapi_status_t sapi_safechannel_open(sapi_safechannel_t *channel, const sapi_safechannel_config_t *config);

sapi_status_t sapi_safechannel_send(sapi_safechannel_t *channel, const uint8_t *payload, size_t payload_size);

sapi_status_t sapi_safechannel_receive(sapi_safechannel_t *channel, uint8_t *out_payload, size_t max_size,
                                        sapi_duration_ms_t timeout_ms, size_t *out_size);

sapi_safechannel_link_status_t sapi_safechannel_get_status(const sapi_safechannel_t *channel);

sapi_status_t sapi_safechannel_close(sapi_safechannel_t *channel);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAPI_SAFECHANNEL_H */
 /* SAFECHANNEL */