Reader (C-API)

This page describes the C implementation of Reader

group READER_INIT

Enums

enum a0_reader_init_t

Values:

enumerator A0_INIT_OLDEST
enumerator A0_INIT_MOST_RECENT
enumerator A0_INIT_AWAIT_NEW
group READER_ITER

Enums

enum a0_reader_iter_t

Values:

enumerator A0_ITER_NEXT
enumerator A0_ITER_NEWEST
group READER

Functions

a0_err_t a0_reader_init(a0_reader_t*, a0_arena_t, a0_alloc_t, a0_reader_options_t, a0_packet_callback_t)

a0_err_t a0_reader_close(a0_reader_t*)

struct a0_reader_t
#include <reader.h>
group READER_SYNC

Functions

a0_err_t a0_reader_sync_init(a0_reader_sync_t*, a0_arena_t, a0_alloc_t, a0_reader_options_t)

a0_err_t a0_reader_sync_close(a0_reader_sync_t*)

a0_err_t a0_reader_sync_can_read(a0_reader_sync_t*, bool*)

a0_err_t a0_reader_sync_read(a0_reader_sync_t*, a0_packet_t*)

a0_err_t a0_reader_sync_read_blocking(a0_reader_sync_t*, a0_packet_t*)

a0_err_t a0_reader_sync_read_blocking_timeout(a0_reader_sync_t*, a0_time_mono_t*, a0_packet_t*)

struct a0_reader_sync_t
#include <reader.h>
group READER_ZC

Functions

a0_err_t a0_reader_zc_init(a0_reader_zc_t*, a0_arena_t, a0_reader_options_t, a0_zero_copy_callback_t)

a0_err_t a0_reader_zc_close(a0_reader_zc_t*)

May not be called from within a callback.

struct a0_reader_zc_t
#include <reader.h>
group READER_SYNC_ZC

Functions

a0_err_t a0_reader_sync_zc_init(a0_reader_sync_zc_t*, a0_arena_t, a0_reader_options_t)

a0_err_t a0_reader_sync_zc_close(a0_reader_sync_zc_t*)

a0_err_t a0_reader_sync_zc_can_read(a0_reader_sync_zc_t*, bool*)

a0_err_t a0_reader_sync_zc_read(a0_reader_sync_zc_t*, a0_zero_copy_callback_t)

a0_err_t a0_reader_sync_zc_read_blocking(a0_reader_sync_zc_t*, a0_zero_copy_callback_t)

a0_err_t a0_reader_sync_zc_read_blocking_timeout(a0_reader_sync_zc_t*, a0_time_mono_t*, a0_zero_copy_callback_t)

struct a0_reader_sync_zc_t
#include <reader.h>