summaryrefslogtreecommitdiff
path: root/ext/CircularBuffer.h
diff options
context:
space:
mode:
authorVasil Zlatanov <v@skozl.com>2017-05-03 16:30:16 +0100
committerVasil Zlatanov <v@skozl.com>2017-05-03 16:30:16 +0100
commita6ed1742539c62186fb903017b52dd48f145ae4f (patch)
treee9f49f0437e1f260b276b45fddcb66ea524f49e3 /ext/CircularBuffer.h
downloade2-switch-a6ed1742539c62186fb903017b52dd48f145ae4f.tar.gz
e2-switch-a6ed1742539c62186fb903017b52dd48f145ae4f.tar.bz2
e2-switch-a6ed1742539c62186fb903017b52dd48f145ae4f.zip
Add template and build environment.
Diffstat (limited to 'ext/CircularBuffer.h')
-rw-r--r--ext/CircularBuffer.h98
1 files changed, 98 insertions, 0 deletions
diff --git a/ext/CircularBuffer.h b/ext/CircularBuffer.h
new file mode 100644
index 0000000..e9f3f1c
--- /dev/null
+++ b/ext/CircularBuffer.h
@@ -0,0 +1,98 @@
+/* mbed Microcontroller Library
+ * Copyright (c) 2015 ARM Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+#ifndef MBED_CIRCULARBUFFER_H
+#define MBED_CIRCULARBUFFER_H
+
+namespace mbed {
+
+/** Templated Circular buffer class
+ */
+template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
+class CircularBuffer {
+public:
+ CircularBuffer() : _head(0), _tail(0), _full(false) {
+ }
+
+ ~CircularBuffer() {
+ }
+
+ /** Push the transaction to the buffer. This overwrites the buffer if it's
+ * full
+ *
+ * @param data Data to be pushed to the buffer
+ */
+ void push(const T& data) {
+ if (full()) {
+ _tail++;
+ _tail %= BufferSize;
+ }
+ _pool[_head++] = data;
+ _head %= BufferSize;
+ if (_head == _tail) {
+ _full = true;
+ }
+ }
+
+ /** Pop the transaction from the buffer
+ *
+ * @param data Data to be pushed to the buffer
+ * @return True if the buffer is not empty and data contains a transaction, false otherwise
+ */
+ bool pop(T& data) {
+ if (!empty()) {
+ data = _pool[_tail++];
+ _tail %= BufferSize;
+ _full = false;
+ return true;
+ }
+ return false;
+ }
+
+ /** Check if the buffer is empty
+ *
+ * @return True if the buffer is empty, false if not
+ */
+ bool empty() {
+ return (_head == _tail) && !_full;
+ }
+
+ /** Check if the buffer is full
+ *
+ * @return True if the buffer is full, false if not
+ */
+ bool full() {
+ return _full;
+ }
+
+ /** Reset the buffer
+ *
+ */
+ void reset() {
+ _head = 0;
+ _tail = 0;
+ _full = false;
+ }
+
+private:
+ T _pool[BufferSize];
+ volatile CounterType _head;
+ volatile CounterType _tail;
+ volatile bool _full;
+};
+
+}
+
+#endif