eq::base::LFQueue< T > Class Template Reference
A thread-safe, lock-free queue with non-blocking access. More...
#include <lfQueue.h>
Inheritance diagram for eq::base::LFQueue< T >:
Collaboration diagram for eq::base::LFQueue< T >:
Public Member Functions | |
| LFQueue (const int32_t size) | |
| Construct a new queue. | |
| ~LFQueue () | |
| Destruct this queue. | |
| bool | isEmpty () const |
| void | clear () |
| Reset (empty) the queue. | |
| bool | pop (T &result) |
| Retrieve and pop the front element from the queue. | |
| bool | getFront (T &result) |
| Retrieve the front element from the queue. | |
| bool | push (const T &element) |
| Push a new element to the back of the queue. | |
Detailed Description
template<typename T>
class eq::base::LFQueue< T >
A thread-safe, lock-free queue with non-blocking access.
Typically used for caches and non-blocking communication between two execution threads.
Current implementation constraints:
- One reader thread
- One writer thread
- Fixed maximum size (writes may fail)
- Not copyable
Definition at line 46 of file lfQueue.h.
Constructor & Destructor Documentation
template<typename T>
| eq::base::LFQueue< T >::LFQueue | ( | const int32_t | size | ) | [inline] |
template<typename T>
| eq::base::LFQueue< T >::~LFQueue | ( | ) | [inline] |
Member Function Documentation
template<typename T>
| bool eq::base::LFQueue< T >::isEmpty | ( | ) | const [inline] |
template<typename T>
| void eq::base::LFQueue< T >::clear | ( | ) | [inline] |
Reset (empty) the queue.
- Version:
- 1.0
Definition at line 61 of file lfQueue.h.
Referenced by eq::net::RSPConnection::close().
Here is the caller graph for this function:
template<typename T>
| bool eq::base::LFQueue< T >::pop | ( | T & | result | ) | [inline] |
template<typename T>
| bool eq::base::LFQueue< T >::getFront | ( | T & | result | ) | [inline] |
template<typename T>
| bool eq::base::LFQueue< T >::push | ( | const T & | element | ) | [inline] |
Push a new element to the back of the queue.
- Parameters:
-
element the element to add.
- Returns:
- true if the element was placed, false if the queue is full
- Version:
- 1.0
Definition at line 112 of file lfQueue.h.
Referenced by eq::net::RSPConnection::readSync(), and eq::net::RSPConnection::write().
Here is the caller graph for this function:
The documentation for this class was generated from the following file:
