kcenon::thread::policies::dynamic_bounded_policy Class Reference

Policy with dynamically adjustable size limit. More...

#include <bound_policies.h>

Collaboration diagram for kcenon::thread::policies::dynamic_bounded_policy:

Public Types
using	policy_tag = bound_policy_tag

Public Member Functions
constexpr	dynamic_bounded_policy (std::optional< std::size_t > max=std::nullopt) noexcept
	Construct with optional max size.
constexpr auto	is_full (std::size_t current_size) const noexcept -> bool
	Check if queue is at capacity.
constexpr auto	max_size () const noexcept -> std::optional< std::size_t >
	Get maximum size.
constexpr auto	is_bounded () const noexcept -> bool
	Check if this is currently bounded.
constexpr auto	remaining_capacity (std::size_t current_size) const noexcept -> std::size_t
	Get remaining capacity.
auto	set_max_size (std::size_t new_max) noexcept -> void
	Set new maximum size.
auto	set_unbounded () noexcept -> void
	Remove size limit (become unbounded)

Private Attributes
std::optional< std::size_t >	max_size_

Detailed Description

Policy with dynamically adjustable size limit.

Similar to bounded_policy but allows runtime changes to the limit and can be switched to unbounded mode.

Usage

dynamic_bounded_policy bound(1000);
// Later:
bound.set_max_size(2000);  // Increase limit
bound.set_unbounded();     // Remove limit entirely

Definition at line 177 of file bound_policies.h.

Member Typedef Documentation

policy_tag

using kcenon::thread::policies::dynamic_bounded_policy::policy_tag = bound_policy_tag

Definition at line 179 of file bound_policies.h.

Constructor & Destructor Documentation

dynamic_bounded_policy()

kcenon::thread::policies::dynamic_bounded_policy::dynamic_bounded_policy ( std::optional< std::size_t > max = std::nullopt )

inlineexplicitconstexprnoexcept

Construct with optional max size.

Parameters

max	Optional maximum size (nullopt for unbounded)

Definition at line 185 of file bound_policies.h.

        : max_size_(max) {}

Member Function Documentation

is_bounded()

auto kcenon::thread::policies::dynamic_bounded_policy::is_bounded ( ) const -> bool

inlinenodiscardconstexprnoexcept

Check if this is currently bounded.

Returns

true if max size is set

Definition at line 213 of file bound_policies.h.

                                                                     {
        return max_size_.has_value();
    }

References max_size_.

is_full()

auto kcenon::thread::policies::dynamic_bounded_policy::is_full ( std::size_t current_size ) const -> bool

inlinenodiscardconstexprnoexcept

Check if queue is at capacity.

Parameters

current_size

Current queue size

Returns

true if bounded and at or above max size

Definition at line 194 of file bound_policies.h.

                                                                                        {
        if (!max_size_.has_value()) {
            return false;
        }
        return current_size >= max_size_.value();
    }

References max_size_.

max_size()

auto kcenon::thread::policies::dynamic_bounded_policy::max_size ( ) const -> std::optional<std::size_t>

inlinenodiscardconstexprnoexcept

Get maximum size.

Returns

The configured maximum size, or nullopt if unbounded

Definition at line 205 of file bound_policies.h.

                                                                                     {
        return max_size_;
    }

References max_size_.

remaining_capacity()

auto kcenon::thread::policies::dynamic_bounded_policy::remaining_capacity ( std::size_t current_size ) const -> std::size_t

inlinenodiscardconstexprnoexcept

Get remaining capacity.

Parameters

current_size

Current queue size

Returns

Number of items that can still be added

Definition at line 222 of file bound_policies.h.

                                                                                                        {
        if (!max_size_.has_value()) {
            return std::numeric_limits<std::size_t>::max();
        }
        if (current_size >= max_size_.value()) {
            return 0;
        }
        return max_size_.value() - current_size;
    }

References max_size_.

set_max_size()

auto kcenon::thread::policies::dynamic_bounded_policy::set_max_size ( std::size_t new_max ) -> void

inlinenoexcept

Set new maximum size.

Parameters

new_max

New maximum size

Definition at line 236 of file bound_policies.h.

                                                          {
        max_size_ = new_max;
    }

References max_size_.

set_unbounded()

auto kcenon::thread::policies::dynamic_bounded_policy::set_unbounded ( ) -> void

inlinenoexcept

Remove size limit (become unbounded)

Definition at line 243 of file bound_policies.h.

                                          {
        max_size_ = std::nullopt;
    }

References max_size_.

Member Data Documentation

max_size_

std::optional<std::size_t> kcenon::thread::policies::dynamic_bounded_policy::max_size_

private

Definition at line 248 of file bound_policies.h.

Referenced by is_bounded(), is_full(), max_size(), remaining_capacity(), set_max_size(), and set_unbounded().

---

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

• include/kcenon/thread/policies/bound_policies.h