AVRTools/RingBuffer_8h_source.html

/*

    RingBuffer.h - A ring buffer class for AVR processors.

    For AVR ATMega328p (Arduino Uno) and ATMega2560 (Arduino Mega).

    This is part of the AVRTools library.

    Copyright (c) 2014 Igor Mikolic-Torreira.  All right reserved.


    This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by

    the Free Software Foundation, either version 3 of the License, or

    (at your option) any later version.


    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.


    You should have received a copy of the GNU General Public License

    along with this program.  If not, see <http://www.gnu.org/licenses/>.

*/


#ifndef RingBuffer_h

#define RingBuffer_h


#include <util/atomic.h>


class RingBuffer

{

public:


    RingBuffer( unsigned char *buffer, unsigned short size );


    int pull();


    int peek( unsigned short index = 0 );


    bool push( unsigned char element );


    bool isFull();


    bool isNotFull();


    bool isEmpty()

    { return !static_cast<bool>( mLength ); }


    bool isNotEmpty()

    { return static_cast<bool>( mLength ); }


    void clear();


private:


    unsigned char *mBuffer;

    volatile unsigned short mSize;

    volatile unsigned short mLength;

    volatile unsigned short mIndex;


};


#endif


RingBuffer
This class provides an efficient ring buffer implementation for storing bytes. Ring buffers are parti...
Definition RingBuffer.h:61

RingBuffer::isFull
bool isFull()
Determine if the buffer is full and cannot accept more bytes.
Definition RingBuffer.cpp:89

RingBuffer::pull
int pull()
Extract the next (first) byte from the ring buffer.
Definition RingBuffer.cpp:36

RingBuffer::isNotFull
bool isNotFull()
Determine if the buffer is not full and can accept more bytes.
Definition RingBuffer.cpp:98

RingBuffer::peek
int peek(unsigned short index=0)
Examine an element in the ring buffer.
Definition RingBuffer.cpp:56

RingBuffer::clear
void clear()
Clear the ring buffer, leaving it empty.
Definition RingBuffer.cpp:109

RingBuffer::isEmpty
bool isEmpty()
Determine if the buffer is empty .
Definition RingBuffer.h:119

RingBuffer::push
bool push(unsigned char element)
Push a byte into the ring buffer. The element is appended to the back of the buffer.
Definition RingBuffer.cpp:70

RingBuffer::isNotEmpty
bool isNotEmpty()
Determine if the buffer is not empty.
Definition RingBuffer.h:127