event.h

Go to the documentation of this file.

#pragma once

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

#ifdef __cplusplus
extern "C" {
#endif

// TYPES

typedef void *sys_event_t;

typedef struct sys_event_queue_t sys_event_queue_t;

// LIFECYCLE

sys_event_queue_t *sys_event_queue_init(size_t capacity);

void sys_event_queue_deinit(sys_event_queue_t *queue);

// METHODS

bool sys_event_queue_push(sys_event_queue_t *queue, sys_event_t event);

bool sys_event_queue_try_push(sys_event_queue_t *queue, sys_event_t event);

sys_event_t sys_event_queue_peek(sys_event_queue_t *queue);

sys_event_t sys_event_queue_pop(sys_event_queue_t *queue);

sys_event_t sys_event_queue_try_pop(sys_event_queue_t *queue);

sys_event_t sys_event_queue_timed_pop(sys_event_queue_t *queue,
                                      uint32_t timeout_ms);

size_t sys_event_queue_size(sys_event_queue_t *queue);

bool sys_event_queue_empty(sys_event_queue_t *queue);

void sys_event_queue_shutdown(sys_event_queue_t *queue);

bool sys_event_queue_lock(sys_event_queue_t *queue);

bool sys_event_queue_unlock(sys_event_queue_t *queue);

#ifdef __cplusplus
}
#endif