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.
Fork of
mbed-src
by 
mbed official
CircularBuffer< T, BufferSize, CounterType > Class Template Reference
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 () |
| Check if the buffer is empty. | |
| bool | full () |
| Check if the buffer is full. | |
| void | reset () |
| Reset the buffer. | |
Detailed Description
template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
class mbed::CircularBuffer< T, BufferSize, CounterType >
Templated Circular buffer class.
Definition at line 24 of file CircularBuffer.h.
Member Function Documentation
| bool empty | ( | ) |
Check if the buffer is empty.
- Returns:
- True if the buffer is empty, false if not
Definition at line 68 of file CircularBuffer.h.
| bool full | ( | ) |
Check if the buffer is full.
- Returns:
- True if the buffer is full, false if not
Definition at line 76 of file CircularBuffer.h.
| bool pop | ( | T & | data ) |
Pop the transaction from the buffer.
- Parameters:
-
data Data to be pushed to the buffer
- Returns:
- True if the buffer is not empty and data contains a transaction, false otherwise
Definition at line 54 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 37 of file CircularBuffer.h.
| void reset | ( | ) |
Reset the buffer.
Definition at line 83 of file CircularBuffer.h.
Generated on Tue Jul 12 2022 16:30:33 by
1.7.2