1 //this is a single reader [maybe multiple writer?] byte queue
2 //Copyright 2008 Alex Norman
3 //writen by Alex Norman
5 //This file is part of avr-bytequeue.
7 //avr-bytequeue is free software: you can redistribute it and/or modify
8 //it under the terms of the GNU General Public License as published by
9 //the Free Software Foundation, either version 3 of the License, or
10 //(at your option) any later version.
12 //avr-bytequeue is distributed in the hope that it will be useful,
13 //but WITHOUT ANY WARRANTY; without even the implied warranty of
14 //MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 //GNU General Public License for more details.
17 //You should have received a copy of the GNU General Public License
18 //along with avr-bytequeue. If not, see <http://www.gnu.org/licenses/>.
30 typedef uint8_t byteQueueIndex_t;
33 byteQueueIndex_t start;
35 byteQueueIndex_t length;
39 //you must have a queue, an array of data which the queue will use, and the length of that array
40 void bytequeue_init(byteQueue_t * queue, uint8_t * dataArray, byteQueueIndex_t arrayLen);
42 //add an item to the queue, returns false if the queue is full
43 bool bytequeue_enqueue(byteQueue_t * queue, uint8_t item);
45 //get the length of the queue
46 byteQueueIndex_t bytequeue_length(byteQueue_t * queue);
48 //this grabs data at the index given [starting at queue->start]
49 uint8_t bytequeue_get(byteQueue_t * queue, byteQueueIndex_t index);
51 //update the index in the queue to reflect data that has been dealt with
52 void bytequeue_remove(byteQueue_t * queue, byteQueueIndex_t numToRemove);