StdDeQueue.hpp

Go to the documentation of this file.

#ifndef IOMANAGER_INCLUDE_IOMANAGER_STDDEQUEUE_HPP_
#define IOMANAGER_INCLUDE_IOMANAGER_STDDEQUEUE_HPP_
 
#include "iomanager/queue/Queue.hpp"
 
#include <atomic>
#include <cassert>
#include <chrono>
#include <condition_variable>
#include <deque>
#include <functional>
#include <iostream>
#include <mutex>
#include <sstream>
#include <string>
#include <thread>
#include <type_traits>
#include <utility>
 
namespace dunedaq::iomanager {
template<class T>
class StdDeQueue : public Queue<T>
{
public:
  using value_t = T;                                
  using duration_t = typename Queue<T>::duration_t; 
 
  explicit StdDeQueue(const std::string& name, size_t capacity);
 
  bool can_pop() const noexcept override { return this->get_num_elements() > 0; }
  void pop(value_t& val, const duration_t&) override; // Throws QueueTimeoutExpired if a timeout occurs
  bool try_pop(value_t& val, const duration_t&) override;
 
  bool can_push() const noexcept override { return this->get_num_elements() < this->get_capacity(); }
  void push(value_t&&, const duration_t&) override; // Throws QueueTimeoutExpired if a timeout occurs
  bool try_push(value_t&&, const duration_t&) override;
 
  size_t get_capacity() const override { return m_capacity; }
 
  size_t get_num_elements() const override { return m_size.load(std::memory_order_acquire); }
 
  // Delete the copy and move operations since various member data instances
  // (e.g., of std::mutex or of std::atomic) aren't copyable or movable
 
  StdDeQueue(const StdDeQueue&) = delete;            
  StdDeQueue& operator=(const StdDeQueue&) = delete; 
  StdDeQueue(StdDeQueue&&) = delete;                 
  StdDeQueue& operator=(StdDeQueue&&) = delete;      
 
private:
  void try_lock_for(std::unique_lock<std::mutex>&, const duration_t&);
 
  std::deque<value_t> m_deque;
  size_t m_capacity;
  std::atomic<size_t> m_size = 0;
 
  std::mutex m_mutex;
  std::condition_variable m_no_longer_full;
  std::condition_variable m_no_longer_empty;
};
 
} // namespace dunedaq::iomanager
 
#include "detail/StdDeQueue.hxx"
 
#endif // IOMANAGER_INCLUDE_IOMANAGER_STDDEQUEUE_HPP_