Rtos API example
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. |
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
Definition at line 34 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 83 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 94 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 66 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 47 of file CircularBuffer.h.
void reset | ( | void | ) |
Reset the buffer.
Definition at line 104 of file CircularBuffer.h.
CounterType size | ( | ) | const |
Get the number of elements currently stored in the circular_buffer.
Definition at line 113 of file CircularBuffer.h.
Generated on Sun Jul 17 2022 08:25:44 by 1.7.2