thread_pool_interface.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 "executor_interface.h"
#include "../patterns/result.h"
#include <cstddef>
 
namespace kcenon::common {
namespace interfaces {
 
class IThreadPool : public IExecutor {
public:
    virtual ~IThreadPool() = default;
 
    // ===== Thread pool sizing =====
 
    virtual VoidResult resize(size_t new_size) = 0;
 
    virtual size_t min_workers() const { return 1; }
 
    virtual size_t max_workers() const { return 0; }
 
    // ===== Queue management =====
 
    virtual VoidResult set_queue_capacity(size_t capacity) = 0;
 
    virtual size_t get_queue_capacity() const = 0;
 
    virtual bool is_queue_full() const = 0;
 
    virtual size_t clear_pending_tasks() = 0;
 
    // ===== Lifecycle control =====
 
    virtual VoidResult start() = 0;
 
    virtual VoidResult stop(bool wait_for_completion = true) = 0;
 
    virtual VoidResult pause() = 0;
 
    virtual VoidResult resume() = 0;
 
    virtual bool is_paused() const = 0;
 
    // ===== Statistics =====
 
    virtual size_t active_tasks() const = 0;
 
    virtual size_t idle_workers() const = 0;
 
    virtual size_t completed_tasks() const { return 0; }
 
    virtual size_t failed_tasks() const { return 0; }
};
 
using ThreadPoolFactory = std::function<std::shared_ptr<IThreadPool>(size_t worker_count)>;
 
class IThreadPoolProvider {
public:
    virtual ~IThreadPoolProvider() = default;
 
    virtual std::shared_ptr<IThreadPool> get_thread_pool() = 0;
 
    virtual Result<std::shared_ptr<IThreadPool>> create_thread_pool(
        size_t worker_count,
        size_t queue_capacity = 0) = 0;
};
 
} // namespace interfaces
} // namespace kcenon::common