SynchronizedQueue.hpp

Go to the documentation of this file.

// @formatter:off
//
// Balau core C++ library
//
// Copyright (C) 2008 Bora Software (contact@borasoftware.com)
//
// Licensed under the Boost Software License - Version 1.0 - August 17th, 2003.
// See the LICENSE file for the full license text.
//


#ifndef COM_BORA_SOFTWARE__BALAU_CONTAINER__SYNCHRONISED_QUEUE
#define COM_BORA_SOFTWARE__BALAU_CONTAINER__SYNCHRONISED_QUEUE

#include <Balau/Exception/ContainerExceptions.hpp>
#include <Balau/Container/Queue.hpp>
#include <Balau/Type/StdTypes.hpp>

#include <list>
#include <mutex>

namespace Balau::Container {

template <typename T> class SynchronizedQueue : public Queue<T> {
    public: void enqueue(T && element) override {
        std::lock_guard<std::mutex> lock(mutex);
        elements.push_back(std::move(element));
    }

    public: T dequeue() override {
        std::lock_guard<std::mutex> lock(mutex);

        if (elements.empty()) {
            ThrowBalauException(Exception::EmptyException, "Synchronised queue is empty.");
        }

        T element = std::move(elements.front());
        elements.pop_front();
        return element;
    }

    public: bool empty() const override {
        std::lock_guard<std::mutex> lock(mutex);
        return elements.size() == 0;
    }


    private: std::list<T> elements;
    private: mutable std::mutex mutex;
};

} // namespace Balau::Container

#endif // COM_BORA_SOFTWARE__BALAU_CONTAINER__SYNCHRONISED_QUEUE