forward.h

Go to the documentation of this file.

#pragma once
 
// BSD 3-Clause License
// Copyright (c) 2024, 🍀☀🌕🌥 🌊
// See the LICENSE file in the project root for full license information.
 
#include <cstdint>
 
namespace kcenon::thread {
 
// ============================================================================
// Core types
// ============================================================================
 
class thread_pool;
struct thread_pool_config;
class thread_worker;
class thread_base;
class job;
class job_queue;
class cancellation_token;
 
// ============================================================================
// Typed thread pool types
// ============================================================================
 
enum class job_types : uint8_t;
 
template<typename JobType>
class typed_thread_pool_t;
 
template<typename JobType>
class typed_thread_worker_t;
 
template<typename JobType>
class typed_job_t;
 
template<typename JobType>
class callback_typed_job_t;
 
template<typename JobType>
class typed_job_interface;
 
// ============================================================================
// Builder and policy types
// ============================================================================
 
class thread_pool_builder;
class pool_factory;
struct worker_policy;
enum class scheduling_policy;
enum class worker_state;
 
// ============================================================================
// Pool policy types
// ============================================================================
 
class pool_policy;
class circuit_breaker_policy;
 
template<typename JobType>
class typed_thread_pool_builder;
 
// ============================================================================
// Scaling and resilience types
// ============================================================================
 
// circuit_breaker and circuit_breaker_config live in kcenon::common::resilience
// and are imported via using declarations in headers that need them
class autoscaler;
struct autoscaling_policy;
class numa_work_stealer;
class pool_queue_adapter_interface;
 
// ============================================================================
// Queue types
// ============================================================================
 
class adaptive_job_queue;
 
// ============================================================================
// Policy types (in policies sub-namespace)
// ============================================================================
 
namespace policies {
    // Sync policies
    class mutex_sync_policy;
    class lockfree_sync_policy;
    class adaptive_sync_policy;
 
    // Bound policies
    class unbounded_policy;
    class bounded_policy;
    class dynamic_bounded_policy;
 
    // Overflow policies
    class overflow_reject_policy;
    class overflow_block_policy;
    class overflow_drop_oldest_policy;
    class overflow_drop_newest_policy;
    class overflow_timeout_policy;
}  // namespace policies
 
template<typename SyncPolicy, typename BoundPolicy, typename OverflowPolicy>
class policy_queue;
 
// ============================================================================
// Internal implementation types (detail namespace)
// ============================================================================
 
namespace detail {
    class lockfree_job_queue;
 
    template<typename T>
    class concurrent_queue;
}  // namespace detail
 
// ============================================================================
// Metrics types (in metrics sub-namespace)
// ============================================================================
 
namespace metrics {
    class MetricsBase;
    class ThreadPoolMetrics;
    class EnhancedThreadPoolMetrics;
    class MetricsBackend;
    class PrometheusBackend;
    class JsonBackend;
    class LoggingBackend;
    class BackendRegistry;
    struct BaseSnapshot;
    struct EnhancedSnapshot;
    struct WorkerMetrics;
}  // namespace metrics
 
// ============================================================================
// Diagnostics types (in diagnostics sub-namespace)
// ============================================================================
 
namespace diagnostics {
    class thread_pool_diagnostics;
    struct job_info;
    struct thread_info;
    struct health_status;
    struct component_health;
    struct bottleneck_report;
    struct job_execution_event;
    struct diagnostics_config;
    class execution_event_listener;
 
    enum class job_status;
    enum class worker_state;
    enum class health_state;
    enum class bottleneck_type;
    enum class event_type;
}  // namespace diagnostics
 
// ============================================================================
// Synchronization primitives (in sync sub-namespace)
// ============================================================================
 
namespace sync {
    template<typename Mutex>
    class scoped_lock_guard;
}
 
// ============================================================================
// Async operation types (C++20 only)
// ============================================================================
 
#if __cplusplus >= 202002L && __has_include(<coroutine>)
template<typename T>
class task;
 
template<typename T>
class awaitable;
#endif
 
} // namespace kcenon::thread