SyncQueue.h

/*
 * Copyright (C) 2019-2021 HERE Europe B.V.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * License-Filename: LICENSE
 */
 
#pragma once
 
#include <condition_variable>
#include <deque>
#include <mutex>
#include <queue>
 
#include <olp/core/CoreApi.h>
 
namespace olp {
namespace thread {
 
template <typename T, typename Container>
class CORE_API SyncQueue final {
 public:
  SyncQueue() noexcept;
  ~SyncQueue();
 
  SyncQueue(const SyncQueue&) = delete;
  SyncQueue& operator=(const SyncQueue&) = delete;
  SyncQueue(SyncQueue&&) = delete;
  SyncQueue& operator=(SyncQueue&&) = delete;
 
  bool Empty() const;
 
  void Close();
 
  bool Pull(T& element);
 
  void Push(T&& element);
 
  void Push(const T& element);
 
 private:
  Container queue_;
  mutable std::mutex mutex_;
  std::condition_variable ready_;
  bool closed_;
};
 
template <typename T>
using SyncQueueFifo = SyncQueue<T, std::queue<T, std::deque<T>>>;
 
}  // namespace thread
}  // namespace olp
 
#include "SyncQueue.inl"