PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/CircularBuffer.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

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