Jhon Plantikow / mbed

.

Dependents:   RTC

CircularBuffer.h@0:88e313c910d0, 2015-08-13 (annotated)

Committer:
jhon309
Date:
Thu Aug 13 00:20:09 2015 +0000
Revision:
0:88e313c910d0
RTC Example

Who changed what in which revision?

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