sorted_queue.hpp
Go to the documentation of this file.
#ifndef OSMIUM_THREAD_SORTED_QUEUE_HPP
#define OSMIUM_THREAD_SORTED_QUEUE_HPP
/*
This file is part of Osmium (http://osmcode.org/libosmium).
Copyright 2013-2016 Jochen Topf <jochen@topf.org> and others (see README).
Boost Software License - Version 1.0 - August 17th, 2003
Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:
The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
#include <condition_variable>
#include <cstddef>
#include <deque>
#include <mutex>
namespace osmium {
namespace thread {
template <typename T>
class SortedQueue {
typedef typename std::deque<T>::size_type size_type;
mutable std::mutex m_mutex;
std::deque<T> m_queue;
std::condition_variable m_data_available;
size_type m_offset;
// this method expects that we already have the lock
bool empty_intern() const {
return m_queue.front() == T();
}
public:
SortedQueue() :
m_mutex(),
m_queue(1),
m_data_available(),
m_offset(0) {
}
void push(T value, size_type num) {
std::lock_guard<std::mutex> lock(m_mutex);
num -= m_offset;
if (m_queue.size() <= num + 1) {
m_queue.resize(num + 2);
}
m_queue[num] = std::move(value);
m_data_available.notify_one();
}
void wait_and_pop(T& value) {
std::unique_lock<std::mutex> lock(m_mutex);
m_data_available.wait(lock, [this] {
return !empty_intern();
});
value = std::move(m_queue.front());
m_queue.pop_front();
++m_offset;
}
bool try_pop(T& value) {
std::lock_guard<std::mutex> lock(m_mutex);
if (empty_intern()) {
return false;
}
value = std::move(m_queue.front());
m_queue.pop_front();
++m_offset;
return true;
}
bool empty() const {
std::lock_guard<std::mutex> lock(m_mutex);
return empty_intern();
}
size_t size() const {
std::lock_guard<std::mutex> lock(m_mutex);
return m_queue.size();
}
}; // class SortedQueue
} // namespace thread
} // namespace osmium
#endif // OSMIUM_THREAD_SORTED_QUEUE_HPP
osmium::thread::SortedQueue::wait_and_pop
void wait_and_pop(T &value)
Definition: sorted_queue.hpp:104
osmium::thread::SortedQueue::push
void push(T value, size_type num)
Definition: sorted_queue.hpp:88
osmium::thread::SortedQueue::size_type
std::deque< T >::size_type size_type
Definition: sorted_queue.hpp:59
osmium
Namespace for everything in the Osmium library.
Definition: assembler.hpp:59
osmium::thread::SortedQueue::m_data_available
std::condition_variable m_data_available
Definition: sorted_queue.hpp:63
osmium::thread::SortedQueue::m_mutex
std::mutex m_mutex
Definition: sorted_queue.hpp:61
osmium::thread::SortedQueue::m_offset
size_type m_offset
Definition: sorted_queue.hpp:65
osmium::thread::SortedQueue
Definition: sorted_queue.hpp:57
osmium::thread::SortedQueue::empty
bool empty() const
Definition: sorted_queue.hpp:137
osmium::thread::SortedQueue::empty_intern
bool empty_intern() const
Definition: sorted_queue.hpp:68
osmium::thread::SortedQueue::SortedQueue
SortedQueue()
Definition: sorted_queue.hpp:74
osmium::thread::SortedQueue::try_pop
bool try_pop(T &value)
Definition: sorted_queue.hpp:119
osmium::thread::SortedQueue::size
size_t size() const
Definition: sorted_queue.hpp:148
osmium::thread::SortedQueue::m_queue
std::deque< T > m_queue
Definition: sorted_queue.hpp:62