pool_queue_adapter.h

Go to the documentation of this file.

// BSD 3-Clause License
// Copyright (c) 2025, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include <memory>
#include <vector>
#include <string>
 
#include <kcenon/thread/core/job.h>
#include <kcenon/thread/core/error_handling.h>
#include <kcenon/thread/interfaces/scheduler_interface.h>
#include <kcenon/thread/interfaces/queue_capabilities_interface.h>
 
namespace kcenon::thread {
 
// Forward declarations
class job_queue;
 
template<typename SyncPolicy, typename BoundPolicy, typename OverflowPolicy>
class policy_queue;
 
class pool_queue_adapter_interface {
public:
    virtual ~pool_queue_adapter_interface() = default;
 
    [[nodiscard]] virtual auto enqueue(std::unique_ptr<job>&& job) -> common::VoidResult = 0;
 
    [[nodiscard]] virtual auto enqueue_batch(std::vector<std::unique_ptr<job>>&& jobs) -> common::VoidResult = 0;
 
    [[nodiscard]] virtual auto dequeue() -> common::Result<std::unique_ptr<job>> = 0;
 
    [[nodiscard]] virtual auto try_dequeue() -> common::Result<std::unique_ptr<job>> = 0;
 
    [[nodiscard]] virtual auto empty() const -> bool = 0;
 
    [[nodiscard]] virtual auto size() const -> std::size_t = 0;
 
    virtual auto clear() -> void = 0;
 
    virtual auto stop() -> void = 0;
 
    [[nodiscard]] virtual auto is_stopped() const -> bool = 0;
 
    [[nodiscard]] virtual auto get_capabilities() const -> queue_capabilities = 0;
 
    [[nodiscard]] virtual auto to_string() const -> std::string = 0;
 
    [[nodiscard]] virtual auto get_job_queue() const -> std::shared_ptr<job_queue> = 0;
 
    [[nodiscard]] virtual auto get_scheduler() -> scheduler_interface& = 0;
 
    [[nodiscard]] virtual auto get_scheduler() const -> const scheduler_interface& = 0;
};
 
} // namespace kcenon::thread