Queue.h

#ifndef theplu_yat_utility_queue
#define theplu_yat_utility_queue

// $Id: Queue.h 3689 2017-09-12 03:46:44Z peter $
//
// Copyright (C) 2013, 2014, 2016, 2017 Peter Johansson
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

#include "config_public.h"

#include <boost/thread.hpp>

#include <deque>
#include <utility>

namespace theplu {
namespace yat {
namespace utility {

  template<typename T>
  class Queue
  {
  public:
    typedef T value_type;

    typedef typename std::deque<T>::size_type size_type;

    Queue(void) {}

    Queue(const Queue& other) : q_(other.q()) {}

    void clear(void)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      return q_.clear();
    }

    bool empty(void) const
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      return q_.empty();
    } // lock is released here


    void pop(T& value)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      while (q_.empty())
        condition_.wait(lock);
      // The obvious choice would be to create a temp copy of front,
      // pop the queue and then return by-value. This is, however,
      // dangerous becasue if the copy constructor throws, the queue
      // has been popped and the element is lost. Instead we choose to
      // pass via passed reference.
      value = q_.front();
      q_.pop_front();
    } // lock is released here


    void push(const T& t)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      q_.push_back(t);
      lock.unlock(); // unlock the mutex

      // Notify others that data is ready after we have unlocked
      condition_.notify_one();
    }


#ifdef YAT_HAVE_RVALUE

    void push(T&& t)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      q_.push_back(std::move(t));
      lock.unlock(); // unlock the mutex

      // Notify others that data is ready after we have unlocked
      condition_.notify_one();
    }
#endif


    size_type size(void) const
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      return q_.size();
    } // lock is released here


    bool try_pop(T& value)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      if (q_.empty())
        return false;
      value = q_.front();
      q_.pop_front();
      return true;
    } // lock is released here


    Queue& operator=(const Queue& lhs)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      q_ = lhs.q();
      return *this;
    } // lock is released here

  private:
    std::deque<T> q_;
    mutable boost::mutex mutex_;
    boost::condition_variable condition_;

    // thread safe way to access nderlying data
    const std::deque<T>& q(void) const
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      return q_;
    } // lock is released here
  };

}}}
#endif