rtrlib/rtr/rtr.h

/*
 * This file is part of RTRlib.
 *
 * This file is subject to the terms and conditions of the MIT license.
 * See the file LICENSE in the top level directory for more details.
 *
 * Website: http://rtrlib.realmv6.org/
 */


#ifndef RTR_H
#define RTR_H
#include <pthread.h>
#include <stdbool.h>
#include <stdint.h>

enum rtr_rtvals {
    RTR_SUCCESS = 0,
    RTR_ERROR = -1,
    RTR_INVALID_PARAM = -2
};

enum rtr_interval_mode {
    RTR_INTERVAL_MODE_IGNORE_ANY,         /*< Ignore appliance of interval values at all. */
    RTR_INTERVAL_MODE_ACCEPT_ANY,         /*< Accept any interval values, even if outside of range. */
    RTR_INTERVAL_MODE_DEFAULT_MIN_MAX,    /*< If interval value is outside of range, apply min (if below range) or max (if above range). */
    RTR_INTERVAL_MODE_IGNORE_ON_FAILURE   /*< Ignore any interval values that are outside of range. */
};

enum rtr_socket_state {
    RTR_CONNECTING,

    RTR_ESTABLISHED,

    RTR_RESET,

    RTR_SYNC,

    RTR_FAST_RECONNECT,

    RTR_ERROR_NO_DATA_AVAIL,

    RTR_ERROR_NO_INCR_UPDATE_AVAIL,

    RTR_ERROR_FATAL,

    RTR_ERROR_TRANSPORT,

    RTR_SHUTDOWN,

    RTR_CLOSED,
};

struct rtr_socket;

typedef void (*rtr_connection_state_fp)(const struct rtr_socket *rtr_socket, const enum rtr_socket_state state, void *connection_state_fp_param_config, void *connection_state_fp_param_group);

struct rtr_socket {
    struct tr_socket *tr_socket;
    unsigned int refresh_interval;
    time_t last_update;
    unsigned int expire_interval;
    unsigned int retry_interval;
    enum rtr_interval_mode iv_mode;
    enum rtr_socket_state state;
    uint32_t session_id;
    bool request_session_id;
    uint32_t serial_number;
    struct pfx_table *pfx_table;
    pthread_t thread_id;
    rtr_connection_state_fp connection_state_fp;
    void *connection_state_fp_param_config;
    void *connection_state_fp_param_group;
    unsigned int version;
    bool has_received_pdus;
    struct spki_table *spki_table;
    bool is_resetting;
};


const char *rtr_state_to_str(enum rtr_socket_state state);

void rtr_set_interval_mode(struct rtr_socket *rtr_socket, enum rtr_interval_mode option);

enum rtr_interval_mode rtr_get_interval_mode(struct rtr_socket *rtr_socket);
#endif
/* @} */

---