xroad_rate_control.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdbool.h>
#include <stdint.h>
#include <common/xroad_common_types.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct
{
   uint64_t rate; //< Number of events per interval. If rate is 0, rate control is allowing all
   xroad_timestamp_t per; //< Rate interval
   xroad_timestamp_t last_check_time; //< Timestamp of last rate control check
   uint64_t timestamps_start_pos; //< Start pos in timestamps
   uint64_t timestamps_amount; //< Amount of stored timestamps
   xroad_timestamp_t* timestamps; //< Timestamps array
} xroad_rate_control_t;
 
void xroad_rate_control_init(xroad_rate_control_t* ctx);
 
xroad_errno_t xroad_rate_control_set_options(xroad_rate_control_t* ctx, uint64_t rate, xroad_timestamp_t per);
 
bool xroad_rate_control_allow_to_process(xroad_rate_control_t* ctx, xroad_timestamp_t current_time);
 
void xroad_rate_control_processed(xroad_rate_control_t* ctx);
 
void xroad_rate_control_clear(xroad_rate_control_t* ctx);
 
#ifdef __cplusplus
}
#endif