rte_safechannel.h

Go to the documentation of this file.

#ifndef RTE_SAFECHANNEL_H
#define RTE_SAFECHANNEL_H
 
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
 
#include "rte/redundancy/dual/rte_dual_channel.h"
#include "rte/oal/netlink/rte_netlink.h"
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
#include "rte/redundancy/channel_link/rte_channel.h"
#include "rte/redundancy/voter/rte_voter.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define RTE_SAFECHANNEL_MAX_LINKS 4U

typedef enum rte_safechannel_type_e
{
    RTE_SAFECHANNEL_TYPE_DUAL_REDUNDANT = 0,
    RTE_SAFECHANNEL_TYPE_VITAL_VOTED = 1
} rte_safechannel_type_t;

typedef enum rte_safechannel_link_status_e
{
    RTE_SAFECHANNEL_LINK_DOWN     = 0, 
    RTE_SAFECHANNEL_LINK_DEGRADED = 1, 
    RTE_SAFECHANNEL_LINK_FULL     = 2  
} rte_safechannel_link_status_t;

typedef struct rte_safechannel_endpoint_s
{
    rte_netlink_role_t role;
    const char *host;
    uint16_t port;
} rte_safechannel_endpoint_t;

typedef struct rte_safechannel_dual_config_s
{
    rte_safechannel_endpoint_t endpoints[RTE_SAFECHANNEL_MAX_LINKS];
    uint32_t link_count;
    uint32_t sender_id;
    uint32_t expected_peer_id;
    rte_duration_ms_t connect_timeout_ms;
    rte_duration_ms_t ack_timeout_ms;
    rte_dual_channel_status_callback_t status_callback;
    void *status_callback_ctx;
} rte_safechannel_dual_config_t;

typedef struct rte_safechannel_vital_config_s
{
    rte_safechannel_endpoint_t endpoints[RTE_SAFECHANNEL_MAX_LINKS];
    uint32_t link_count;
    size_t message_size;
    rte_voting_strategy_t voting_strategy;
    uint32_t quorum_size;
    rte_duration_ms_t connect_timeout_ms;
    rte_duration_ms_t channel_timeout_ms;
    bool log_disagreements;
    void (*on_disagreement)(void *context, rte_voting_result_t result);
    void *context;
} rte_safechannel_vital_config_t;

typedef struct rte_safechannel_config_s
{
    rte_safechannel_type_t type;
    union
    {
        rte_safechannel_dual_config_t  dual;
        rte_safechannel_vital_config_t vital;
    } as;
} rte_safechannel_config_t;

typedef struct rte_safechannel_s
{
    rte_safechannel_type_t type;
    bool                    is_open;

    rte_netlink_storage_t links[RTE_SAFECHANNEL_MAX_LINKS];
    rte_netlink_handle_t  link_handles[RTE_SAFECHANNEL_MAX_LINKS];
    uint32_t                link_count;
 
    union
    {
        rte_dual_channel_t dual;
        struct
        {
            rte_channel_t channels[RTE_SAFECHANNEL_MAX_LINKS];
            rte_voter_t         voter;
        } vital;
    } impl;
} rte_safechannel_t;

rte_status_t rte_safechannel_open(rte_safechannel_t *channel, const rte_safechannel_config_t *config);

rte_status_t rte_safechannel_send(rte_safechannel_t *channel, const uint8_t *payload, size_t payload_size);

rte_status_t rte_safechannel_receive(rte_safechannel_t *channel, uint8_t *out_payload, size_t max_size,
                                        rte_duration_ms_t timeout_ms, size_t *out_size);

rte_safechannel_link_status_t rte_safechannel_get_status(const rte_safechannel_t *channel);

rte_status_t rte_safechannel_close(rte_safechannel_t *channel);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_SAFECHANNEL_H */
 /* SAFECHANNEL */