Struct ControllerConfig

Source

pub struct ControllerConfig { /* private fields */ }

Available on crate feature controller only.

Expand description

Resource limits for one supervisor’s controller.

Pass this value to SupervisorBuilder::with_controller before building the supervisor. Default gives every limit a finite value.

§What each limit controls

identity_operation_capacity bounds concurrent registry-backed remove and cancel operations.
max_total_pending bounds slot-queue entries plus waits for runtime registry command capacity.
admission_capacity bounds waits for runtime registry command capacity.
max_controller_slots bounds distinct slots tracked at once.
queue_capacity bounds commands waiting for the controller loop.
max_slot_queue bounds FIFO work behind one busy slot owner.

§How limits appear to callers

Submit::execute waits when the ordered command queue is full. Submit::try_intake instead returns ControllerError::Full. Admission limits are checked later. A submission configured with watch() reports them through TaskOutcome::Rejected. A full slot queue uses RejectionKind::QueueFull. The admission, slot-count, and total-pending budgets use RejectionKind::ResourceLimit.

A remove or cancel operation that must reach the registry returns RuntimeError::ResourceLimitReached from execute().await when the identity-operation budget is exhausted. Controller-local queued removal is handled before this limit.

§Examples

use std::num::NonZeroUsize;
use taskvisor::ControllerConfig;

let config = ControllerConfig::default()
    .with_queue_capacity(NonZeroUsize::new(256).unwrap())
    .with_max_slot_queue(32)
    .with_max_controller_slots(NonZeroUsize::new(512));

assert_eq!(config.queue_capacity().get(), 256);
assert_eq!(config.max_slot_queue(), 32);

Implementations§

Source §

impl ControllerConfig

Source

pub const fn new(queue_capacity: NonZeroUsize, max_slot_queue: usize) -> Self

Controller limits initialized from command capacity and per-slot queue depth.

The admission and identity-operation budgets start at queue_capacity. The optional slot and total-pending limits also start at queue_capacity. Configuration methods can tune them independently.

SupervisorBuilder::try_build rejects a command capacity above the async implementation limit. A max_slot_queue value of 0 rejects every Queue submission behind a busy slot. Replace can still create or replace the queue head.

Source

pub fn try_new( queue_capacity: usize, max_slot_queue: usize, ) -> Result<Self, ConfigError>

Validated controller limits from a raw command-queue capacity.

§Errors

ConfigError::Zero when queue_capacity is zero;
ConfigError::TooLarge when queue_capacity exceeds the bounded async implementation limit.

Source

pub const fn queue_capacity(&self) -> NonZeroUsize

Ordered controller command-channel capacity.

Source

pub const fn admission_capacity(&self) -> NonZeroUsize

Maximum simultaneous registry-capacity reservations.

Source

pub const fn identity_operation_capacity(&self) -> NonZeroUsize

Concurrent registry-backed remove and cancel budget.

Source

pub const fn max_slot_queue(&self) -> usize

Per-slot pending limit checked by Queue submissions.

The owner is excluded. A replacement head is included. Replace does not use this limit.

Source

pub const fn max_controller_slots(&self) -> Option<NonZeroUsize>

Optional tracked-slot limit.

The default equals the command capacity passed to new.

Source

pub const fn max_total_pending(&self) -> Option<NonZeroUsize>

Optional total pending-submission limit.

Slot queues and waits for registry command capacity are included. Buffered controller commands and tasks already handed to the registry are excluded. The default equals the command capacity passed to new.

Source