Skip to content
A circular buffer written in C using Posix calls to create a contiguously mapped memory space. BSD Licensed.
C Makefile Shell
Branch: master
Clone or download
Latest commit 00eed6a Jan 27, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc Added documentation Nov 10, 2014
tests Added new capacity test Nov 24, 2014
.travis.yml Added documentation Nov 10, 2014
LICENSE Moved license out of source file Nov 10, 2014
Makefile
README.rst Added bipbuffer hint Feb 15, 2015
cbuffer.c Added new capacity test Nov 24, 2014
cbuffer.h Improve documentation Jan 27, 2016
package.json Added documentation Nov 10, 2014

README.rst

Circular buffers are tricky. The caller needs to know if the polled item crosses the maximum size of the underlying array.

This circular buffer uses a mmap magic trick to make the caller's life easier.

This is how we do it:

  1. mmap is used to mirror the buffer like below:
doc/circular_buffer_mmap.png
  1. the "mirrored" buffer is then placed beside the buffer. When the user polls the item it doesn't matter if the item crosses the buffer's boundary:
doc/circular_buffer_mmap_portal.png

Compatibility

This only works on UNIX systems.

Windows support existed in d10238600a82de32fe1cb01bec8667d3a67e382c but was removed. This is because Windows doesn't actually have mmap and trying to get the same behaviour is painful. Maybe you should check this out instead: https://github.com/willemt/bipbuffer

You can’t perform that action at this time.