RingBuffer.h
/* Teensy 4, 3.x, LC ADC library
* https://github.com/pedvide/ADC
* Copyright (c) 2019 Pedro Villanueva
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
#ifndef RINGBUFFER_H
#define RINGBUFFER_H
// include new and delete
//#include <Arduino.h>
// THE SIZE MUST BE A POWER OF 2!!
#define RING_BUFFER_DEFAULT_BUFFER_SIZE 8
class RingBuffer
{
public:
RingBuffer();
virtual ~RingBuffer();
int isFull();
int isEmpty();
void write(int value);
int read();
protected:
private:
int increase(int p);
int b_size = RING_BUFFER_DEFAULT_BUFFER_SIZE;
int b_start = 0;
int b_end = 0;
//int *elems;
int elems[RING_BUFFER_DEFAULT_BUFFER_SIZE];
};
#endif // RINGBUFFER_H
RingBuffer::~RingBuffer
virtual ~RingBuffer()
RingBuffer::isEmpty
int isEmpty()
Returns 1 (true) if the buffer is empty.
RingBuffer::isFull
int isFull()
Returns 1 (true) if the buffer is full.
RingBuffer::write
void write(int value)
Write a value into the buffer.
RingBuffer
Definition: RingBuffer.h:40
RingBuffer::read
int read()
Read a value from the buffer.
RingBuffer::RingBuffer
RingBuffer()
Default constructor, buffer has a size DEFAULT_BUFFER_SIZE.