Bob Seque / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

api/CircularBuffer.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 0:9b334a45a8ff 1 /* mbed Microcontroller Library
bogdanm 0:9b334a45a8ff 2 * Copyright (c) 2015 ARM Limited
bogdanm 0:9b334a45a8ff 3 *
bogdanm 0:9b334a45a8ff 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 0:9b334a45a8ff 5 * you may not use this file except in compliance with the License.
bogdanm 0:9b334a45a8ff 6 * You may obtain a copy of the License at
bogdanm 0:9b334a45a8ff 7 *
bogdanm 0:9b334a45a8ff 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 0:9b334a45a8ff 9 *
bogdanm 0:9b334a45a8ff 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 0:9b334a45a8ff 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 0:9b334a45a8ff 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 0:9b334a45a8ff 13 * See the License for the specific language governing permissions and
bogdanm 0:9b334a45a8ff 14 * limitations under the License.
bogdanm 0:9b334a45a8ff 15 */
bogdanm 0:9b334a45a8ff 16 #ifndef MBED_CIRCULARBUFFER_H
bogdanm 0:9b334a45a8ff 17 #define MBED_CIRCULARBUFFER_H
bogdanm 0:9b334a45a8ff 18
bogdanm 0:9b334a45a8ff 19 namespace mbed {
bogdanm 0:9b334a45a8ff 20
bogdanm 0:9b334a45a8ff 21 /** Templated Circular buffer class
bogdanm 0:9b334a45a8ff 22 */
bogdanm 0:9b334a45a8ff 23 template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
bogdanm 0:9b334a45a8ff 24 class CircularBuffer {
bogdanm 0:9b334a45a8ff 25 public:
bogdanm 0:9b334a45a8ff 26 CircularBuffer() : _head(0), _tail(0), _full(false) {
bogdanm 0:9b334a45a8ff 27 }
bogdanm 0:9b334a45a8ff 28
bogdanm 0:9b334a45a8ff 29 ~CircularBuffer() {
bogdanm 0:9b334a45a8ff 30 }
bogdanm 0:9b334a45a8ff 31
bogdanm 0:9b334a45a8ff 32 /** Push the transaction to the buffer. This overwrites the buffer if it's
bogdanm 0:9b334a45a8ff 33 * full
bogdanm 0:9b334a45a8ff 34 *
bogdanm 0:9b334a45a8ff 35 * @param data Data to be pushed to the buffer
bogdanm 0:9b334a45a8ff 36 */
bogdanm 0:9b334a45a8ff 37 void push(const T& data) {
bogdanm 0:9b334a45a8ff 38 if (full()) {
bogdanm 0:9b334a45a8ff 39 _tail++;
bogdanm 0:9b334a45a8ff 40 _tail %= BufferSize;
bogdanm 0:9b334a45a8ff 41 }
bogdanm 0:9b334a45a8ff 42 _pool[_head++] = data;
bogdanm 0:9b334a45a8ff 43 _head %= BufferSize;
bogdanm 0:9b334a45a8ff 44 if (_head == _tail) {
bogdanm 0:9b334a45a8ff 45 _full = true;
bogdanm 0:9b334a45a8ff 46 }
bogdanm 0:9b334a45a8ff 47 }
bogdanm 0:9b334a45a8ff 48
bogdanm 0:9b334a45a8ff 49 /** Pop the transaction from the buffer
bogdanm 0:9b334a45a8ff 50 *
bogdanm 0:9b334a45a8ff 51 * @param data Data to be pushed to the buffer
bogdanm 0:9b334a45a8ff 52 * @return True if the buffer is not empty and data contains a transaction, false otherwise
bogdanm 0:9b334a45a8ff 53 */
bogdanm 0:9b334a45a8ff 54 bool pop(T& data) {
bogdanm 0:9b334a45a8ff 55 if (!empty()) {
bogdanm 0:9b334a45a8ff 56 data = _pool[_tail++];
bogdanm 0:9b334a45a8ff 57 _tail %= BufferSize;
bogdanm 0:9b334a45a8ff 58 _full = false;
bogdanm 0:9b334a45a8ff 59 return true;
bogdanm 0:9b334a45a8ff 60 }
bogdanm 0:9b334a45a8ff 61 return false;
bogdanm 0:9b334a45a8ff 62 }
bogdanm 0:9b334a45a8ff 63
bogdanm 0:9b334a45a8ff 64 /** Check if the buffer is empty
bogdanm 0:9b334a45a8ff 65 *
bogdanm 0:9b334a45a8ff 66 * @return True if the buffer is empty, false if not
bogdanm 0:9b334a45a8ff 67 */
bogdanm 0:9b334a45a8ff 68 bool empty() {
bogdanm 0:9b334a45a8ff 69 return (_head == _tail) && !_full;
bogdanm 0:9b334a45a8ff 70 }
bogdanm 0:9b334a45a8ff 71
bogdanm 0:9b334a45a8ff 72 /** Check if the buffer is full
bogdanm 0:9b334a45a8ff 73 *
bogdanm 0:9b334a45a8ff 74 * @return True if the buffer is full, false if not
bogdanm 0:9b334a45a8ff 75 */
bogdanm 0:9b334a45a8ff 76 bool full() {
bogdanm 0:9b334a45a8ff 77 return _full;
bogdanm 0:9b334a45a8ff 78 }
bogdanm 0:9b334a45a8ff 79
bogdanm 0:9b334a45a8ff 80 /** Reset the buffer
bogdanm 0:9b334a45a8ff 81 *
bogdanm 0:9b334a45a8ff 82 */
bogdanm 0:9b334a45a8ff 83 void reset() {
bogdanm 0:9b334a45a8ff 84 _head = 0;
bogdanm 0:9b334a45a8ff 85 _tail = 0;
bogdanm 0:9b334a45a8ff 86 _full = false;
bogdanm 0:9b334a45a8ff 87 }
bogdanm 0:9b334a45a8ff 88
bogdanm 0:9b334a45a8ff 89 private:
bogdanm 0:9b334a45a8ff 90 T _pool[BufferSize];
bogdanm 0:9b334a45a8ff 91 volatile CounterType _head;
bogdanm 0:9b334a45a8ff 92 volatile CounterType _tail;
bogdanm 0:9b334a45a8ff 93 volatile bool _full;
bogdanm 0:9b334a45a8ff 94 };
bogdanm 0:9b334a45a8ff 95
bogdanm 0:9b334a45a8ff 96 }
bogdanm 0:9b334a45a8ff 97
bogdanm 0:9b334a45a8ff 98 #endif