source: trunk/yat/utility/BasicQueue.h @ 3751

#ifndef theplu_yat_utility_basic_queue
#define theplu_yat_utility_basic_queue

// $Id: BasicQueue.h 3751 2018-10-17 01:49:41Z peter $
//
// Copyright (C) 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 yat. If not, see <http://www.gnu.org/licenses/>.

#include "config_public.h"

#include <boost/thread.hpp>

namespace theplu {
namespace yat {
namespace utility {
namespace detail {

  /**
     \internal Base class for Queue and PriorityQueue
   */
  template<class Derived, typename T, class Container>
  class BasicQueue
  {
  public:
    /// Type of object stored
    typedef typename Container::value_type value_type;

    /**
       An unsigned integral type. \see size(void)
    */
    typedef typename Container::size_type size_type;

    /**
       Default constructor
     */
    BasicQueue(void) {}

    /**
       Copy constructor
     */
    BasicQueue(const BasicQueue& other)
    {
      boost::unique_lock<boost::mutex> lock(other.mutex_);
      q_ = other.q_;
    } // lock is released here

    /**
       Construct queue from underlying Container
     */
    explicit BasicQueue(const Container& container) : q_(container) {}

    /**
       \brief clear queue

       \since new in yat 0.15
     */
    void clear(void)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      return q_.clear();
    }


    /**
       \return \c true if container's size is zero
     */
    bool empty(void) const
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      return q_.empty();
    } // lock is released here


    /**
       \brief access next element in queue

       Access the next element is queue. If container is empty,
       process is waiting until other process is inserting element
       into container.
     */
    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.
      static_cast<Derived*>(this)->pop_impl(value, lock);
    } // lock is released here


    /**
       \brief insert an element into container
     */
    void push(const T& t)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      static_cast<Derived*>(this)->push_impl(t, lock);
      lock.unlock(); // unlock the mutex

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


#ifdef YAT_HAVE_RVALUE
    /**
       \brief insert an element into container

       \note only available if configured and built with cxx11 support

       \since New in yat 0.15
     */
    void push(T&& t)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      static_cast<Derived*>(this)->push_impl(std::move(t), lock);
      lock.unlock(); // unlock the mutex

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


    /**
       \return Number of elements stored in container
     */
    size_type size(void) const
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      return q_.size();
    } // lock is released here


    /**
       If Queue is empty() do nothing and return \c false, else pop
       the element into \a value and return \c true
     */
    bool try_pop(T& value)
    {
      boost::unique_lock<boost::mutex> lock(mutex_);
      if (q_.empty())
        return false;
      static_cast<Derived*>(this)->pop_impl(value, lock);
      return true;
    } // lock is released here

  protected:
    /**
       assign other to this
     */
    void assign(const BasicQueue& other)
    {
      if (this != &other) {
        // boost::lock guarantees that the two mutexes are locked in
        // the same order regardless of passed order and thereby
        // avoiding deadlock when two threads are calling
        // lhs.assign(rhs) and rhs.assign(lhs) simultaneously.
        boost::lock(mutex_, other.mutex_);
        boost::unique_lock<boost::mutex> lock(mutex_, boost::adopt_lock_t());
        boost::unique_lock<boost::mutex> other_lock(other.mutex_,
                                                    boost::adopt_lock_t());
        q_ = other.q_;
      }
    }

    /// data
    Container q_;
  private:
    mutable boost::mutex mutex_;
    boost::condition_variable condition_;
  };

}}}}
#endif