rte_dual_negotiator.h

Go to the documentation of this file.

#ifndef RTE_DUAL_NEGOTIATOR_H
#define RTE_DUAL_NEGOTIATOR_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "rte/redundancy/dual/rte_dual_channel.h"
#include "rte/redundancy/dual/rte_dual_types.h"
#include "rte/utils/status/rte_status.h"
#include "rte/utils/types/rte_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef void (*rte_dual_negotiator_state_change_callback_t)(rte_dual_state_t new_own_state,
                                                               rte_dual_state_t old_own_state,
                                                               rte_dual_state_t new_peer_state,
                                                               rte_dual_state_t old_peer_state, void *user_ctx);

typedef struct rte_dual_negotiator_s
{
    rte_dual_channel_t *channel;
    uint32_t              own_id;
    uint32_t              peer_id;
    rte_duration_ms_t     peer_lost_timeout_ms;
    rte_dual_negotiator_state_change_callback_t state_change_callback;
    void                  *state_change_callback_ctx;
 
    uint64_t own_startup_timestamp_ms;
    bool     own_channel_degraded;
 
    bool     have_peer_startup_timestamp;
    uint64_t peer_startup_timestamp_ms;
    bool     peer_channel_degraded;
 
    rte_dual_state_t own_state;
    rte_dual_state_t peer_state;
 
    bool                have_last_peer_seen;
    rte_timestamp_ms_t last_peer_seen_ms;
} rte_dual_negotiator_t;

typedef struct rte_dual_negotiator_config_s
{
    rte_dual_channel_t *channel;
    uint32_t own_id;
    uint32_t peer_id;
    rte_duration_ms_t peer_lost_timeout_ms;
    rte_dual_negotiator_state_change_callback_t state_change_callback;
    void *state_change_callback_ctx;
    rte_dual_state_t resume_own_state;
    uint64_t resume_own_startup_timestamp_ms;
} rte_dual_negotiator_config_t;

rte_status_t rte_dual_negotiator_init(rte_dual_negotiator_t *negotiator,
                                         const rte_dual_negotiator_config_t *config);

rte_status_t rte_dual_negotiator_execute(rte_dual_negotiator_t *negotiator, rte_duration_ms_t receive_timeout_ms);

rte_dual_state_t rte_dual_negotiator_get_own_state(const rte_dual_negotiator_t *negotiator);

rte_dual_state_t rte_dual_negotiator_get_peer_state(const rte_dual_negotiator_t *negotiator);

uint64_t rte_dual_negotiator_get_own_startup_timestamp_ms(const rte_dual_negotiator_t *negotiator);

uint64_t rte_dual_negotiator_get_peer_startup_timestamp_ms(const rte_dual_negotiator_t *negotiator);

uint32_t rte_dual_negotiator_get_own_id(const rte_dual_negotiator_t *negotiator);

uint32_t rte_dual_negotiator_get_peer_id(const rte_dual_negotiator_t *negotiator);
 
#ifdef __cplusplus
}
#endif
 
#endif /* RTE_DUAL_NEGOTIATOR_H */