spsc_ring_queue.h

Go to the documentation of this file.

 
#ifndef CPPCOMMON_THREADS_SPSC_RING_QUEUE_H
#define CPPCOMMON_THREADS_SPSC_RING_QUEUE_H
 
#include <atomic>
#include <cassert>
#include <cstdio>
#include <cstring>
#include <utility>
 
namespace CppCommon {
 
 
template<typename T>
class SPSCRingQueue
{
public:
 
    explicit SPSCRingQueue(size_t capacity);
    SPSCRingQueue(const SPSCRingQueue&) = delete;
    SPSCRingQueue(SPSCRingQueue&&) = delete;
    ~SPSCRingQueue() { delete[] _buffer; }
 
    SPSCRingQueue& operator=(const SPSCRingQueue&) = delete;
    SPSCRingQueue& operator=(SPSCRingQueue&&) = delete;
 
    explicit operator bool() const noexcept { return !empty(); }
 
    bool empty() const noexcept { return (size() == 0); }
    size_t capacity() const noexcept { return _capacity; }
    size_t size() const noexcept;
 
 
    bool Enqueue(const T& item);
 
    bool Enqueue(T&& item);
 
 
    bool Dequeue(T& item);
 
private:
    typedef char cache_line_pad[128];
 
    cache_line_pad _pad0;
    const size_t _capacity;
    const size_t _mask;
    T* const _buffer;
 
    cache_line_pad _pad1;
    std::atomic<size_t> _head;
    cache_line_pad _pad2;
    std::atomic<size_t> _tail;
    cache_line_pad _pad3;
};
 
} // namespace CppCommon
 
#include "spsc_ring_queue.inl"
 
#endif // CPPCOMMON_THREADS_SPSC_RING_QUEUE_H