executor_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 <chrono>
#include <functional>
#include <future>
#include <memory>
#include <string>
#include "../patterns/result.h"
 
namespace kcenon::common {
namespace interfaces {
 
class IJob {
public:
    virtual ~IJob() = default;
 
    virtual VoidResult execute() = 0;
 
    virtual std::string get_name() const { return "unnamed_job"; }
 
    virtual int get_priority() const { return 0; }
};
 
class IExecutor {
public:
    virtual ~IExecutor() = default;
 
    // ===== Job-based execution =====
 
    virtual Result<std::future<void>> execute(std::unique_ptr<IJob>&& job) = 0;
 
    virtual Result<std::future<void>> execute_delayed(
        std::unique_ptr<IJob>&& job,
        std::chrono::milliseconds delay) = 0;
 
    // ===== Status and control =====
 
    virtual size_t worker_count() const = 0;
 
    virtual bool is_running() const = 0;
 
    virtual size_t pending_tasks() const = 0;
 
    virtual void shutdown(bool wait_for_completion = true) = 0;
};
 
using ExecutorFactory = std::function<std::shared_ptr<IExecutor>()>;
 
class IExecutorProvider {
public:
    virtual ~IExecutorProvider() = default;
 
    virtual std::shared_ptr<IExecutor> get_executor() = 0;
 
    virtual std::shared_ptr<IExecutor> create_executor(size_t worker_count) = 0;
};
 
} // namespace interfaces
} // namespace kcenon::common