eloop.c's Introduction

eloop.c

Simple single threaded event loop API

why ?

To learn and experiment

install

$ clib install jwerle/eloop.c

usage

#include <stdio.h>
#include <eloop/eloop.h>

static int
work (void *data) {
  printf("%s\n", (char *) data);
  return EL_WORK_COMPLETE;
}

int
main (int argc, char **argv) {
  el_t *loop = el_alloc();
  el_enqueue(loop, "hello", work);
  return el_run(loop);
}

api

Worker status codes:

EL_WORK_ERROR = -1
EL_WORK_PENDING = 0
EL_WORK_COMPLETE = 1

Event loop API:

/**
 * Worker function with data passed to it
 */

typedef el_work_status_t (*el_work_handle_t) (void *);

/**
 * Work structure with function handle and data
 */

typedef struct el_work {
  el_work_handle_t handle;
  void *data;
} el_work_t;

/**
 * Event loop arbiter
 */

typedef struct eloop {
  el_work_t *work[EL_MAX_WORK];
  size_t length;
} el_t;

/**
 * Allocates a new `el_t' type
 */

el_t *
el_alloc (void);

/**
 * Frees an event loop
 */

void
el_free (el_t *);

/**
 * Initializes work with argument and function handle
 */

el_work_t *
el_work_init (void *, el_work_handle_t);

/**
 * Destroys work. Does not destroy argument pointer
 */

void
el_work_destroy (el_work_t *);

/**
 * Enqueues work with argument and handle
 */

size_t
el_enqueue (el_t *, void *, el_work_handle_t);

/**
 * Dequeues all queued work
 */

size_t
el_dequeue (el_t *);

/**
 * Runs the event loop
 */

int
el_run (el_t *);