trafilo.h

Go to the documentation of this file.

#ifndef TRAFILO
#define TRAFILO
 
#include <stddef.h>
#include <stdint.h>
#include <time.h>

typedef struct {
    char *key;              /* dispatch key (by dispatching service)*/
    void *payload;          /* binary safe content of event*/ 
    size_t payload_len;     /* binary safe content of event*/
    struct timespec t_secs; /* timestamp of event in nano second precision*/
} event_t;

typedef struct {
    const char      *key;          /* bucket key */
    size_t           event_count;  /* events currently in the window */
    struct timespec  window_start; /* timestamp of oldest retained event */
    struct timespec  window_end;   /* timestamp of newest retained event */
} window_result_t;
 
/*************************
 * User callback functions
 *************************
*/

typedef int (*trafilo_parse_fn)(const char *raw, size_t len, event_t **out);

typedef void (*trafilo_event_free_fn)(event_t *event);

typedef void (*trafilo_handle_fn)(const event_t *event, void *user_state);

typedef void (*trafilo_sink_fn)(const char *key,
                                const window_result_t *result,
                                void *user_state);

typedef void *(*trafilo_state_init_fn)(const char *key);

typedef void (*trafilo_state_free_fn)(void *user_state);

typedef struct {
    /* Network */
    const char *bind_addr;              /* Stream output address*/
    uint16_t    port;                   /* UDP port to bind to */
    int         recv_timeout_ms;        /* SO_RCVTIMEO; 0 = block forever*/
 
    /* Threading and Concurrency*/
    size_t num_workers;                 /* worker thread count */
    size_t num_buckets;                 /* hashmap size, prime number*/
 
    /* Sliding Window */
    long window_size_ms;                /* sliding window length */
    long slide_interval_ms;             /* slide interval, which also determines emit cadence */
    long bucket_idle_timeout_ms;        /* evict bucket if no events for this
                                           long; 0 = never evict */
 
    /* User callback functions */
    trafilo_parse_fn       parse;
    trafilo_event_free_fn  event_free;
    trafilo_handle_fn      handle;
    trafilo_sink_fn        sink;
    trafilo_state_init_fn  state_init;
    trafilo_state_free_fn  state_free;
} trafilo_config_t;
 
/****************
 * API Lifecycle
 ****************
 */
/* opaque framework handle */
typedef struct trafilo trafilo_t;

trafilo_t *trafilo_create(const trafilo_config_t *config);

int trafilo_run(trafilo_t *trafilo);

void trafilo_shutdown(trafilo_t *trafilo);

void trafilo_destroy(trafilo_t *t);

int trafilo_emit(trafilo_t *t, const char *raw, size_t len);
 
#endif