LockedQueue.h

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * 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 2 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/>.
 */
 
#ifndef LOCKEDQUEUE_H
#define LOCKEDQUEUE_H
 
#include <deque>
#include <mutex>
 
template <class T, typename StorageType = std::deque<T> >
class LockedQueue
{
 std::mutex _lock;
 
 StorageType _queue;
 
 volatile bool _canceled;
 
public:
 
 LockedQueue()
 : _canceled(false)
 {
 }
 
 virtual ~LockedQueue()
 {
 }
 
 void add(const T& item)
 {
 lock();
 
 _queue.push_back(item);
 
 unlock();
 }
 
 template<class Iterator>
 void readd(Iterator begin, Iterator end)
 {
 std::lock_guard<std::mutex> lock(_lock);
 _queue.insert(_queue.begin(), begin, end);
 }
 
 bool next(T& result)
 {
 std::lock_guard<std::mutex> lock(_lock);
 
 if (_queue.empty())
 return false;
 
 result = _queue.front();
 _queue.pop_front();
 
 return true;
 }
 
 template<class Checker>
 bool next(T& result, Checker& check)
 {
 std::lock_guard<std::mutex> lock(_lock);
 
 if (_queue.empty())
 return false;
 
 result = _queue.front();
 if (!check.Process(result))
 return false;
 
 _queue.pop_front();
 return true;
 }
 
 T& peek(bool autoUnlock = false)
 {
 lock();
 
 T& result = _queue.front();
 
 if (autoUnlock)
 unlock();
 
 return result;
 }
 
 void cancel()
 {
 std::lock_guard<std::mutex> lock(_lock);
 
 _canceled = true;
 }
 
 bool cancelled()
 {
 std::lock_guard<std::mutex> lock(_lock);
 return _canceled;
 }
 
 void lock()
 {
 this->_lock.lock();
 }
 
 void unlock()
 {
 this->_lock.unlock();
 }
 
 void pop_front()
 {
 std::lock_guard<std::mutex> lock(_lock);
 _queue.pop_front();
 }
 
 bool empty()
 {
 std::lock_guard<std::mutex> lock(_lock);
 return _queue.empty();
 }
};
#endif