work_queue.h

Go to the documentation of this file.

// === work_queue.h ====================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_CORE_OBJ_DETAIL_WORK_QUEUE_H
#define SEN_CORE_OBJ_DETAIL_WORK_QUEUE_H
 
// sen
#include "sen/core/base/class_helpers.h"
#include "sen/core/base/duration.h"
#include "sen/core/base/move_only_function.h"
 
// std
#include <memory>
 
namespace sen::impl
{
 
// Represents a unit of work.
using Call = sen::std_util::move_only_function<void()>;
 
class WorkQueueImpl;

class WorkQueue final
{
public:
  SEN_NOCOPY_NOMOVE(WorkQueue)
 
public:
  WorkQueue(std::size_t maxSize, bool dropOldest);
  ~WorkQueue();
 
public:
  void enable();

  void disable();

  void clear();

  void push(Call&& call, bool force);

  [[nodiscard]] bool executeAll();

  void waitExecuteOne();

  void waitExecuteAll(const Duration& timeout);

  void setOnDropped(std_util::move_only_function<void(const Call&)>&& callback);

  [[nodiscard]] std::size_t getCurrentSize() const noexcept;
 
private:
  std::unique_ptr<WorkQueueImpl> pimpl_;
};
 
}  // namespace sen::impl
 
#endif  // SEN_CORE_OBJ_DETAIL_WORK_QUEUE_H