Giter Club home page Giter Club logo

circular-buffer's Introduction

Circular-Buffer

A circular buffer implemented in C

API

Structures

  typedef uint8_t buffer_el_t;
  
  typedef enum {
      UNKNOWN,
      BUFFER_EMPTY,
      BUFFER_FULL,
      BUFFER_READ,
  } buffer_state_t;
  
  typedef enum {
      BUFFER_ERROR,
      BUFFER_SUCCESS
  } buffer_return_t;
  
  typedef struct {
      int head;
      int tail;
      uint8_t *data;
      int size;
  } buffer_t;
  
  typedef struct {
      buffer_el_t data;
      buffer_return_t ret;
  } buffer_result_t;

Functions

  buffer_t buffer_init(int size);
  buffer_state_t buffer_state(buffer_t *buffer);
  buffer_return_t buffer_push(buffer_t *buffer, buffer_el_t data);
  buffer_result_t buffer_pop(buffer_t *buffer);
  buffer_return_t buffer_free(buffer_t *buffer);

Example

  buffer_t buffer = buffer_init(8);
  
  buffer_return_t el_1_p = buffer_push(&buffer, 'A');
  assert(el_1_p == BUFFER_SUCCESS);
  
  buffer_result_t el_1 = buffer_pop(&buffer);
  assert((&el_1)->ret == BUFFER_SUCCESS);
  assert((&el_1)->data == (buffer_el_t) 'A');

circular-buffer's People

Contributors

garzdin avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.