ringbuf.h

Go to the documentation of this file.

/*
 * ringbuf.h
 *
 * Part of librfn (a general utility library from redfelineninja.org.uk)
 *
 * Copyright (C) 2014 Daniel Thompson <daniel@redfelineninja.org.uk>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 */

#ifndef RF_RINGBUF_H_
#define RF_RINGBUF_H_

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

#include "atomic.h"

typedef struct {
        uint8_t *bufp;
        size_t buf_len;
        atomic_uint readi;
        atomic_uint writei;
} ringbuf_t;

#define RINGBUF_VAR_INIT(bufp, buf_len) \
        { \
                (uint8_t *) (bufp), \
                (buf_len), \
                ATOMIC_VAR_INIT(0), \
                ATOMIC_VAR_INIT(0) \
        }

void ringbuf_init(ringbuf_t *rb, void *bufp, size_t buf_len);

int ringbuf_get(ringbuf_t *rb);

bool ringbuf_empty(ringbuf_t *rb);

bool ringbuf_put(ringbuf_t *rb, uint8_t d);

void ringbuf_putchar(void *rb, char c);

#endif // RF_RINGBUF_H_