rtr.h File Reference

#include <pthread.h>
#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures
struct	rtr_socket
	A RTR socket. More...

Typedefs
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)
	A function pointer that is called if the state of the rtr socket has changed.

Enumerations
enum	rtr_rtvals { RTR_SUCCESS = 0 , RTR_ERROR = -1 , RTR_INVALID_PARAM = -2 }
enum	rtr_interval_mode { RTR_INTERVAL_MODE_IGNORE_ANY , RTR_INTERVAL_MODE_ACCEPT_ANY , RTR_INTERVAL_MODE_DEFAULT_MIN_MAX , RTR_INTERVAL_MODE_IGNORE_ON_FAILURE }
	These modes let the user configure how received intervals should be handled. More...
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 }
	States of the RTR socket. More...

Functions
const char *	rtr_state_to_str (enum rtr_socket_state state)
	Converts a rtr_socket_state to a String.
void	rtr_set_interval_mode (struct rtr_socket *rtr_socket, enum rtr_interval_mode option)
	Set the interval option to the desired one.
enum rtr_interval_mode	rtr_get_interval_mode (struct rtr_socket *rtr_socket)
	Get the current interval mode.