Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
CircularBuffer< T, BufferSize, CounterType > Class Template Reference
[CircularBuffer functions]
Templated Circular buffer class. More...
#include <CircularBuffer.h>
Public Member Functions | |
| void | push (const T &data) |
| Push the transaction to the buffer. | |
| bool | pop (T &data) |
| Pop the transaction from the buffer. | |
| bool | empty () const |
| Check if the buffer is empty. | |
| bool | full () const |
| Check if the buffer is full. | |
| void | reset () |
| Reset the buffer. | |
| CounterType | size () const |
| Get the number of elements currently stored in the circular_buffer. | |
| bool | peek (T &data) const |
| Peek into circular buffer without popping. | |
Detailed Description
template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
class mbed::CircularBuffer< T, BufferSize, CounterType >
Templated Circular buffer class.
- Note:
- Synchronization level: Interrupt safe
- CounterType must be unsigned and consistent with BufferSize
Definition at line 53 of file CircularBuffer.h.
Member Function Documentation
| bool empty | ( | ) | const |
Check if the buffer is empty.
- Returns:
- True if the buffer is empty, false if not
Definition at line 112 of file CircularBuffer.h.
| bool full | ( | ) | const |
Check if the buffer is full.
- Returns:
- True if the buffer is full, false if not
Definition at line 123 of file CircularBuffer.h.
| bool peek | ( | T & | data ) | const |
Peek into circular buffer without popping.
- Parameters:
-
data Data to be peeked from the buffer
- Returns:
- True if the buffer is not empty and data contains a transaction, false otherwise
Definition at line 163 of file CircularBuffer.h.
| bool pop | ( | T & | data ) |
Pop the transaction from the buffer.
- Parameters:
-
data Data to be popped from the buffer
- Returns:
- True if the buffer is not empty and data contains a transaction, false otherwise
Definition at line 95 of file CircularBuffer.h.
| void push | ( | const T & | data ) |
Push the transaction to the buffer.
This overwrites the buffer if it's full
- Parameters:
-
data Data to be pushed to the buffer
Definition at line 76 of file CircularBuffer.h.
| void reset | ( | void | ) |
Reset the buffer.
Definition at line 133 of file CircularBuffer.h.
| CounterType size | ( | ) | const |
Get the number of elements currently stored in the circular_buffer.
Definition at line 142 of file CircularBuffer.h.
Generated on Tue Jul 12 2022 12:22:56 by
1.7.2