kcenon::thread::config_builder Class Reference

Builder for thread_system_config. More...

#include <thread_system_config.h>

Collaboration diagram for kcenon::thread::config_builder:

Public Member Functions
	config_builder ()=default
auto	with_worker_count (std::size_t count) -> config_builder &
	Sets the number of worker threads.
auto	with_queue_capacity (std::size_t capacity) -> config_builder &
	Sets the queue capacity.
auto	enable_backpressure () -> config_builder &
	Enables backpressure with default settings.
auto	with_backpressure_policy (backpressure_policy policy) -> config_builder &
	Sets the backpressure policy.
auto	with_watermarks (double low, double high) -> config_builder &
	Sets backpressure watermarks.
auto	enable_circuit_breaker () -> config_builder &
	Enables circuit breaker with default settings.
auto	with_failure_threshold (std::size_t threshold) -> config_builder &
	Sets circuit breaker failure threshold.
auto	with_open_duration (std::chrono::seconds duration) -> config_builder &
	Sets circuit breaker open duration.
auto	enable_work_stealing () -> config_builder &
	Enables work stealing.
auto	with_work_stealing_params (std::size_t max_attempts, std::chrono::microseconds backoff) -> config_builder &
	Sets work stealing parameters.
auto	enable_priority_aging () -> config_builder &
	Enables priority aging with default settings.
auto	with_priority_aging_params (std::chrono::milliseconds interval, int boost, int max_boost) -> config_builder &
	Sets priority aging parameters.
auto	enable_auto_scaling () -> config_builder &
	Enables auto-scaling.
auto	with_dag_failure_policy (dag_failure_policy policy) -> config_builder &
	Sets DAG failure policy.
auto	with_dag_retry_params (std::size_t max_retries, std::chrono::milliseconds delay) -> config_builder &
	Sets DAG retry parameters.
auto	build () -> thread_system_config
	Builds the final configuration.

Private Attributes
thread_system_config	config_

Detailed Description

Builder for thread_system_config.

Provides a fluent interface for constructing thread_system_config with sensible defaults.

Example Usage

auto config = thread_system_config::builder()
    .with_worker_count(8)
    .with_queue_capacity(5000)
    .enable_backpressure()
    .with_backpressure_policy(backpressure_policy::adaptive)
    .enable_circuit_breaker()
    .with_failure_threshold(5)
    .enable_priority_aging()
    .build();

Definition at line 249 of file thread_system_config.h.

Constructor & Destructor Documentation

config_builder()

kcenon::thread::config_builder::config_builder ( )

default

Member Function Documentation

build()

auto kcenon::thread::config_builder::build ( ) -> thread_system_config

inline

Builds the final configuration.

Validates the configuration and returns it.

Returns

The constructed configuration

Exceptions

std::invalid_argument

if configuration is invalid

Definition at line 437 of file thread_system_config.h.

        {
            if (!config_.is_valid())
            {
                throw std::invalid_argument("Invalid thread_system_config");
            }
            return config_;
        }

References config_, and kcenon::thread::thread_system_config::is_valid().

Here is the call graph for this function:

enable_auto_scaling()

auto kcenon::thread::config_builder::enable_auto_scaling ( ) -> config_builder&

inline

Enables auto-scaling.

Returns

Reference to this builder

Definition at line 398 of file thread_system_config.h.

        {
            config_.scaling.auto_scaling_enabled = true;
            return *this;
        }

References kcenon::thread::thread_system_config::scaling_config::auto_scaling_enabled, config_, and kcenon::thread::thread_system_config::scaling.

enable_backpressure()

auto kcenon::thread::config_builder::enable_backpressure ( ) -> config_builder&

inline

Enables backpressure with default settings.

Returns

Reference to this builder

Definition at line 280 of file thread_system_config.h.

        {
            config_.pool.backpressure.policy = backpressure_policy::block;
            return *this;
        }

References kcenon::thread::thread_system_config::pool_config::backpressure, kcenon::thread::block, config_, kcenon::thread::backpressure_config::policy, and kcenon::thread::thread_system_config::pool.

enable_circuit_breaker()

auto kcenon::thread::config_builder::enable_circuit_breaker ( ) -> config_builder&

inline

Enables circuit breaker with default settings.

Returns

Reference to this builder

Definition at line 314 of file thread_system_config.h.

        {
            config_.resilience.circuit_breaker.failure_threshold = 5;
            return *this;
        }

References kcenon::thread::thread_system_config::resilience_config::circuit_breaker, config_, and kcenon::thread::thread_system_config::resilience.

enable_priority_aging()

auto kcenon::thread::config_builder::enable_priority_aging ( ) -> config_builder&

inline

Enables priority aging with default settings.

Returns

Reference to this builder

Definition at line 371 of file thread_system_config.h.

        {
            config_.scaling.priority_aging.enabled = true;
            return *this;
        }

References config_, kcenon::thread::priority_aging_config::enabled, kcenon::thread::thread_system_config::scaling_config::priority_aging, and kcenon::thread::thread_system_config::scaling.

enable_work_stealing()

auto kcenon::thread::config_builder::enable_work_stealing ( ) -> config_builder&

inline

Enables work stealing.

Returns

Reference to this builder

Definition at line 347 of file thread_system_config.h.

        {
            config_.pool.enable_work_stealing = true;
            return *this;
        }

References config_, kcenon::thread::thread_system_config::pool_config::enable_work_stealing, and kcenon::thread::thread_system_config::pool.

with_backpressure_policy()

auto kcenon::thread::config_builder::with_backpressure_policy ( backpressure_policy policy ) -> config_builder&

inline

Sets the backpressure policy.

Parameters

policy

The backpressure policy to use

Returns

Reference to this builder

Definition at line 291 of file thread_system_config.h.

        {
            config_.pool.backpressure.policy = policy;
            return *this;
        }

References kcenon::thread::thread_system_config::pool_config::backpressure, config_, kcenon::thread::backpressure_config::policy, and kcenon::thread::thread_system_config::pool.

with_dag_failure_policy()

auto kcenon::thread::config_builder::with_dag_failure_policy ( dag_failure_policy policy ) -> config_builder&

inline

Sets DAG failure policy.

Parameters

policy

The failure policy to use

Returns

Reference to this builder

Definition at line 409 of file thread_system_config.h.

        {
            config_.dag.failure_policy = policy;
            return *this;
        }

References config_, kcenon::thread::thread_system_config::dag, and kcenon::thread::dag_config::failure_policy.

with_dag_retry_params()

auto kcenon::thread::config_builder::with_dag_retry_params ( std::size_t max_retries, std::chrono::milliseconds delay ) -> config_builder&

inline

Sets DAG retry parameters.

Parameters

max_retries	Maximum retry attempts
delay	Delay between retries

Returns

Reference to this builder

Definition at line 421 of file thread_system_config.h.

        {
            config_.dag.max_retries = max_retries;
            config_.dag.retry_delay = delay;
            return *this;
        }

References config_, kcenon::thread::thread_system_config::dag, kcenon::thread::delay, kcenon::thread::dag_config::max_retries, and kcenon::thread::dag_config::retry_delay.

with_failure_threshold()

auto kcenon::thread::config_builder::with_failure_threshold ( std::size_t threshold ) -> config_builder&

inline

Sets circuit breaker failure threshold.

Parameters

threshold

Number of consecutive failures to open circuit

Returns

Reference to this builder

Definition at line 325 of file thread_system_config.h.

        {
            config_.resilience.circuit_breaker.failure_threshold = threshold;
            return *this;
        }

References kcenon::thread::thread_system_config::resilience_config::circuit_breaker, config_, and kcenon::thread::thread_system_config::resilience.

with_open_duration()

auto kcenon::thread::config_builder::with_open_duration ( std::chrono::seconds duration ) -> config_builder&

inline

Sets circuit breaker open duration.

Parameters

duration

Time in open state before half-open

Returns

Reference to this builder

Definition at line 336 of file thread_system_config.h.

        {
            // Note: common_system uses 'timeout' instead of 'open_duration'
            config_.resilience.circuit_breaker.timeout = duration;
            return *this;
        }

References kcenon::thread::thread_system_config::resilience_config::circuit_breaker, config_, and kcenon::thread::thread_system_config::resilience.

with_priority_aging_params()

auto kcenon::thread::config_builder::with_priority_aging_params ( std::chrono::milliseconds interval, int boost, int max_boost ) -> config_builder&

inline

Sets priority aging parameters.

Parameters

interval	Aging interval
boost	Boost per interval
max_boost	Maximum boost

Returns

Reference to this builder

Definition at line 384 of file thread_system_config.h.

        {
            config_.scaling.priority_aging.aging_interval = interval;
            config_.scaling.priority_aging.priority_boost_per_interval = boost;
            config_.scaling.priority_aging.max_priority_boost = max_boost;
            return *this;
        }

References kcenon::thread::priority_aging_config::aging_interval, config_, kcenon::thread::priority_aging_config::max_priority_boost, kcenon::thread::thread_system_config::scaling_config::priority_aging, kcenon::thread::priority_aging_config::priority_boost_per_interval, and kcenon::thread::thread_system_config::scaling.

with_queue_capacity()

auto kcenon::thread::config_builder::with_queue_capacity ( std::size_t capacity ) -> config_builder&

inline

Sets the queue capacity.

Parameters

capacity

Maximum queue size

Returns

Reference to this builder

Definition at line 270 of file thread_system_config.h.

        {
            config_.pool.queue_capacity = capacity;
            return *this;
        }

References config_, kcenon::thread::thread_system_config::pool, and kcenon::thread::thread_system_config::pool_config::queue_capacity.

with_watermarks()

auto kcenon::thread::config_builder::with_watermarks ( double low, double high ) -> config_builder&

inline

Sets backpressure watermarks.

Parameters

low	Low watermark (0.0 to 1.0)
high	High watermark (0.0 to 1.0)

Returns

Reference to this builder

Definition at line 303 of file thread_system_config.h.

        {
            config_.pool.backpressure.low_watermark = low;
            config_.pool.backpressure.high_watermark = high;
            return *this;
        }

References kcenon::thread::thread_system_config::pool_config::backpressure, config_, kcenon::thread::high, kcenon::thread::backpressure_config::high_watermark, kcenon::thread::low, kcenon::thread::backpressure_config::low_watermark, and kcenon::thread::thread_system_config::pool.

with_work_stealing_params()

auto kcenon::thread::config_builder::with_work_stealing_params ( std::size_t max_attempts, std::chrono::microseconds backoff ) -> config_builder&

inline

Sets work stealing parameters.

Parameters

max_attempts	Maximum steal attempts
backoff	Backoff duration between attempts

Returns

Reference to this builder

Definition at line 359 of file thread_system_config.h.

        {
            config_.pool.max_steal_attempts = max_attempts;
            config_.pool.steal_backoff = backoff;
            return *this;
        }

References config_, kcenon::thread::thread_system_config::pool_config::max_steal_attempts, kcenon::thread::thread_system_config::pool, and kcenon::thread::thread_system_config::pool_config::steal_backoff.

with_worker_count()

auto kcenon::thread::config_builder::with_worker_count ( std::size_t count ) -> config_builder&

inline

Sets the number of worker threads.

Parameters

count

Number of workers

Returns

Reference to this builder

Definition at line 259 of file thread_system_config.h.

        {
            config_.pool.worker_count = count;
            return *this;
        }

References config_, kcenon::thread::thread_system_config::pool, and kcenon::thread::thread_system_config::pool_config::worker_count.

Member Data Documentation

config_

thread_system_config kcenon::thread::config_builder::config_

private

Definition at line 447 of file thread_system_config.h.

Referenced by build(), enable_auto_scaling(), enable_backpressure(), enable_circuit_breaker(), enable_priority_aging(), enable_work_stealing(), with_backpressure_policy(), with_dag_failure_policy(), with_dag_retry_params(), with_failure_threshold(), with_open_duration(), with_priority_aging_params(), with_queue_capacity(), with_watermarks(), with_work_stealing_params(), and with_worker_count().

---

The documentation for this class was generated from the following file:

• include/kcenon/thread/config/thread_system_config.h