BoundedQueue.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_BoundedQueue_hxx
#define __ccxx_BoundedQueue_hxx

#include <commonc++/Common.h++>
#include <commonc++/ConditionVar.h++>
#include <commonc++/InterruptedException.h++>
#include <commonc++/Mutex.h++>
#include <commonc++/ScopedLock.h++>
#include <commonc++/System.h++>
#include <commonc++/IOException.h++>

#include <deque>

namespace ccxx {

template <typename T> class BoundedQueue
{
 public:

  BoundedQueue(uint_t capacity);

  virtual ~BoundedQueue();

  void clear();

  void reset();

  void put(T item);

  void tryPut(T item, timespan_ms_t timeout = 0);

  T take();

  T tryTake(timespan_ms_t timeout = 0);

  uint_t getSize() const;

  inline uint_t getCapacity() const
  { return(_capacity); }

  void setCapacity(uint_t capacity);

  void interrupt();

  void shutdown();

  inline bool isShutdown() const
  { return(_terminated); }

 private:

  uint_t _capacity;
  std::deque<T> _queue;
  mutable Mutex _mutex;
  ConditionVar _condP;
  ConditionVar _condC;
  bool _terminated;
};

#include <commonc++/BoundedQueueImpl.h++>

} // namespace ccxx

#endif // __ccxx_BoundedQueue_hxx