1 #ifndef BOOST_THREAD_CONCURRENT_QUEUES_DETAIL_SYNC_QUEUE_BASE_HPP
2 #define BOOST_THREAD_CONCURRENT_QUEUES_DETAIL_SYNC_QUEUE_BASE_HPP
4 //////////////////////////////////////////////////////////////////////////////
6 // (C) Copyright Vicente J. Botet Escriba 2013-2017. Distributed under the Boost
7 // Software License, Version 1.0. (See accompanying file
8 // LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
10 // See http://www.boost.org/libs/thread for documentation.
12 //////////////////////////////////////////////////////////////////////////////
14 #include <boost/bind.hpp>
16 #include <boost/thread/detail/config.hpp>
17 #include <boost/thread/condition_variable.hpp>
18 #include <boost/thread/detail/move.hpp>
19 #include <boost/thread/mutex.hpp>
20 #include <boost/thread/concurrent_queues/queue_op_status.hpp>
22 #include <boost/chrono/time_point.hpp>
23 #include <boost/throw_exception.hpp>
25 #include <boost/config/abi_prefix.hpp>
34 template <class ValueType, class Queue>
38 typedef ValueType value_type;
39 typedef Queue underlying_queue_type;
40 typedef typename Queue::size_type size_type;
41 typedef queue_op_status op_status;
43 // Constructors/Assignment/Destructors
44 BOOST_THREAD_NO_COPYABLE(sync_queue_base)
45 inline sync_queue_base();
46 //template <typename Range>
47 //inline explicit sync_queue(Range range);
48 inline ~sync_queue_base();
51 inline bool empty() const;
52 inline bool full() const;
53 inline size_type size() const;
54 inline bool closed() const;
59 inline underlying_queue_type underlying_queue() {
60 lock_guard<mutex> lk(mtx_);
61 return boost::move(data_);
66 condition_variable cond_;
67 underlying_queue_type data_;
70 inline bool empty(unique_lock<mutex>& ) const BOOST_NOEXCEPT
74 inline bool empty(lock_guard<mutex>& ) const BOOST_NOEXCEPT
79 inline size_type size(lock_guard<mutex>& ) const BOOST_NOEXCEPT
83 inline bool closed(unique_lock<mutex>& lk) const;
84 inline bool closed(lock_guard<mutex>& lk) const;
86 inline void throw_if_closed(unique_lock<mutex>&);
87 inline void throw_if_closed(lock_guard<mutex>&);
89 inline bool not_empty_or_closed(unique_lock<mutex>& ) const;
91 inline bool wait_until_not_empty_or_closed(unique_lock<mutex>& lk);
92 template <class WClock, class Duration>
93 queue_op_status wait_until_not_empty_or_closed_until(unique_lock<mutex>& lk, chrono::time_point<WClock,Duration> const&tp);
95 inline void notify_elem_added(unique_lock<mutex>& )
99 inline void notify_elem_added(lock_guard<mutex>& )
106 template <class ValueType, class Queue>
107 sync_queue_base<ValueType, Queue>::sync_queue_base() :
108 data_(), closed_(false)
110 BOOST_ASSERT(data_.empty());
113 template <class ValueType, class Queue>
114 sync_queue_base<ValueType, Queue>::~sync_queue_base()
118 template <class ValueType, class Queue>
119 void sync_queue_base<ValueType, Queue>::close()
122 lock_guard<mutex> lk(mtx_);
128 template <class ValueType, class Queue>
129 bool sync_queue_base<ValueType, Queue>::closed() const
131 lock_guard<mutex> lk(mtx_);
134 template <class ValueType, class Queue>
135 bool sync_queue_base<ValueType, Queue>::closed(unique_lock<mutex>&) const
139 template <class ValueType, class Queue>
140 bool sync_queue_base<ValueType, Queue>::closed(lock_guard<mutex>&) const
145 template <class ValueType, class Queue>
146 bool sync_queue_base<ValueType, Queue>::empty() const
148 lock_guard<mutex> lk(mtx_);
151 template <class ValueType, class Queue>
152 bool sync_queue_base<ValueType, Queue>::full() const
157 template <class ValueType, class Queue>
158 typename sync_queue_base<ValueType, Queue>::size_type sync_queue_base<ValueType, Queue>::size() const
160 lock_guard<mutex> lk(mtx_);
164 template <class ValueType, class Queue>
165 void sync_queue_base<ValueType, Queue>::throw_if_closed(unique_lock<mutex>& lk)
169 BOOST_THROW_EXCEPTION( sync_queue_is_closed() );
172 template <class ValueType, class Queue>
173 void sync_queue_base<ValueType, Queue>::throw_if_closed(lock_guard<mutex>& lk)
177 BOOST_THROW_EXCEPTION( sync_queue_is_closed() );
181 template <class ValueType, class Queue>
182 bool sync_queue_base<ValueType, Queue>::not_empty_or_closed(unique_lock<mutex>& ) const
184 return ! data_.empty() || closed_;
187 template <class ValueType, class Queue>
188 bool sync_queue_base<ValueType, Queue>::wait_until_not_empty_or_closed(unique_lock<mutex>& lk)
190 cond_.wait(lk, boost::bind(&sync_queue_base<ValueType, Queue>::not_empty_or_closed, boost::ref(*this), boost::ref(lk)));
191 if (! empty(lk)) return false; // success
192 return true; // closed
195 template <class ValueType, class Queue>
196 template <class WClock, class Duration>
197 queue_op_status sync_queue_base<ValueType, Queue>::wait_until_not_empty_or_closed_until(unique_lock<mutex>& lk, chrono::time_point<WClock,Duration> const&tp)
199 if (! cond_.wait_until(lk, tp, boost::bind(&sync_queue_base<ValueType, Queue>::not_empty_or_closed, boost::ref(*this), boost::ref(lk))))
200 return queue_op_status::timeout;
201 if (! empty(lk)) return queue_op_status::success;
202 return queue_op_status::closed;
209 #include <boost/config/abi_suffix.hpp>