sapi_dual_negotiator.h

Go to the documentation of this file.

#ifndef SAPI_DUAL_NEGOTIATOR_H
#define SAPI_DUAL_NEGOTIATOR_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "safeapi/redundancy/dual/sapi_dual_channel.h"
#include "safeapi/redundancy/dual/sapi_dual_types.h"
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

typedef void (*sapi_dual_negotiator_state_change_callback_t)(sapi_dual_state_t new_own_state,
                                                               sapi_dual_state_t old_own_state,
                                                               sapi_dual_state_t new_peer_state,
                                                               sapi_dual_state_t old_peer_state, void *user_ctx);

typedef struct sapi_dual_negotiator_s
{
    sapi_dual_channel_t *channel;
    uint32_t              own_id;
    uint32_t              peer_id;
    sapi_duration_ms_t     peer_lost_timeout_ms;
    sapi_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;
 
    sapi_dual_state_t own_state;
    sapi_dual_state_t peer_state;
 
    bool                have_last_peer_seen;
    sapi_timestamp_ms_t last_peer_seen_ms;
} sapi_dual_negotiator_t;

typedef struct sapi_dual_negotiator_config_s
{
    sapi_dual_channel_t *channel;
    uint32_t own_id;
    uint32_t peer_id;
    sapi_duration_ms_t peer_lost_timeout_ms;
    sapi_dual_negotiator_state_change_callback_t state_change_callback;
    void *state_change_callback_ctx;
} sapi_dual_negotiator_config_t;

sapi_status_t sapi_dual_negotiator_init(sapi_dual_negotiator_t *negotiator,
                                         const sapi_dual_negotiator_config_t *config);

sapi_status_t sapi_dual_negotiator_execute(sapi_dual_negotiator_t *negotiator, sapi_duration_ms_t receive_timeout_ms);

sapi_dual_state_t sapi_dual_negotiator_get_own_state(const sapi_dual_negotiator_t *negotiator);

sapi_dual_state_t sapi_dual_negotiator_get_peer_state(const sapi_dual_negotiator_t *negotiator);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAPI_DUAL_NEGOTIATOR_H */