Queue.hpp

Go to the documentation of this file.

 
#ifndef IOMANAGER_INCLUDE_IOMANAGER_QUEUE_HPP_
#define IOMANAGER_INCLUDE_IOMANAGER_QUEUE_HPP_
 
#include "iomanager/queue/QueueBase.hpp"
 
#include "logging/Logging.hpp" // NOTE: if ISSUES ARE DECLARED BEFORE include logging/Logging.hpp, TLOG_DEBUG<<issue wont work.
#include "ers/Issue.hpp"
 
#include <chrono>
#include <cstddef>
#include <memory>
#include <string>
#include <vector>
 
namespace dunedaq {
namespace iomanager {
 
template<class T>
class Queue : public QueueBase
{
public:
  using value_t = T;                            
  using duration_t = std::chrono::milliseconds; 
 
  explicit Queue(const std::string& name)
    : QueueBase(name)
  {}
 
  virtual bool can_push() const { return this->get_num_elements() < this->get_capacity(); }
 
  virtual bool can_pop() const { return this->get_num_elements() > 0; }
 
  virtual void push(value_t&& val, const duration_t& timeout) = 0;
 
  virtual void pop(value_t& val, const duration_t& timeout) = 0;
 
  virtual bool try_push(value_t&& val, const duration_t& timeout) = 0;
  virtual bool try_pop(value_t& val, const duration_t& timeout) = 0;
 
private:
  Queue(const Queue&) = delete;
  Queue& operator=(const Queue&) = delete;
  Queue(Queue&&) = default;
  Queue& operator=(Queue&&) = default;
};
 
} // namespace iomanager
// Disable coverage collection LCOV_EXCL_START
ERS_DECLARE_ISSUE(iomanager,           // namespace
                  QueueTimeoutExpired, // issue class name
                  name << ": Unable to " << func_name << " within timeout period (timeout period was " << timeout
                       << " milliseconds)",                                  // message
                  ((std::string)name)((std::string)func_name)((int)timeout)) // NOLINT(readability/casting)
// Re-enable coverage collection LCOV_EXCL_STOP
} // namespace dunedaq
 
#endif // IOMANAGER_INCLUDE_IOMANAGER_QUEUE_HPP_