template class ThreadSafeRingBuffer
Thread-safe ring buffer used to back logging system.
File location: framework/cauldron/framework/inc/misc/threadsafe_ringbuffer.h
Construction
|
Return type |
Description |
|---|---|
|
Construction with custom initialization.
|
Methods
|
Return type |
Description |
|---|---|
|
void |
Close ()
Closes the ring buffer (takes no more entries).
|
|
bool |
Empty () const
Queries if the ring buffer is empty.
|
|
bool |
Full () const
Queries if the ring buffer is full (at max capacity).
|
|
bool |
Pop (T& item)
Pops an item off the top of the ring buffer. Blocking until the buffer has an element or is closed.
|
|
void |
PushBack (T&& item)
Pushes an item onto the ring buffer. Blocking until there is enough space in the ring buffer if at capacity.
|
Detailed description
Thread-safe ring buffer used to back logging system.
Construction
ThreadSafeRingBuffer
Copied!
ThreadSafeRingBuffer ()Construction with custom initialization.
Methods
Close
Copied!
void Close ()Closes the ring buffer (takes no more entries).
Empty
Copied!
bool Empty () constQueries if the ring buffer is empty.
Full
Copied!
bool Full () constQueries if the ring buffer is full (at max capacity).
Pop
Copied!
bool Pop (T& item)Pops an item off the top of the ring buffer. Blocking until the buffer has an element or is closed.
PushBack
Copied!
void PushBack (T&& item)Pushes an item onto the ring buffer. Blocking until there is enough space in the ring buffer if at capacity.
