Skip to main content

WeightedFairQueue

Struct WeightedFairQueue 

Source
pub struct WeightedFairQueue<T> { /* private fields */ }
Expand description

Weighted-fair queue, parameterized over item type T.

Maintains one virtual sub-queue per active database_id. The dispatcher calls pop_next() to retrieve the next item following deficit round-robin ordering. Total capacity across all virtual queues is bounded; try_enqueue returns Err(item) when the total is full.

Implementations§

Source§

impl<T> WeightedFairQueue<T>

Source

pub fn new(capacity: usize, reap_after_pops: usize) -> Self

Create a new weighted-fair queue with the given total capacity and reap threshold. reap_after_pops controls how many empty queues persist after draining before being garbage-collected.

Source

pub fn try_enqueue(&mut self, database_id: u64, item: T) -> Result<(), T>

Attempt to enqueue item for database_id. Returns Err(item) if the total queue has reached capacity.

Source

pub fn set_priority(&mut self, database_id: u64, cls: PriorityClass)

Set (or update) the priority class for a database. Applied on the next pop_next call after this update.

Source

pub fn pop_next(&mut self) -> Option<T>

Pop the next item using deficit round-robin across all virtual queues.

Returns None if all virtual queues are empty.

Each database is served for up to priority_weight(class) consecutive items before the scheduler rotates to the next database. Deficit credits are added once per turn (when a DB’s deficit reaches zero and it re-enters the front of the rotation) and carried across calls so databases with lower arrival rates still accumulate credits fairly.

Source

pub fn depth_for(&self, database_id: u64) -> usize

Number of items queued for a specific database.

Source

pub fn total_depth(&self) -> usize

Total items across all virtual queues.

Source

pub fn is_throttled_for(&self, database_id: u64) -> bool

Returns true if the given database’s virtual queue has reached ≥ 85% of its fair share of total capacity.

Fair share = capacity / active_databases (floor division, min 1). Databases with higher priority class receive proportionally more fair share in the weight sense but the slot fair share is still equal (per-DB slot pressure uses equal division to avoid one class starving another’s absolute headroom).

Source

pub fn is_suspended_for(&self, database_id: u64) -> bool

Returns true if the given database’s virtual queue has reached ≥ 95% of its fair share of total capacity.

Source

pub fn active_database_count(&self) -> usize

Number of active virtual queues (including empty, not-yet-reaped ones).

Auto Trait Implementations§

§

impl<T> Freeze for WeightedFairQueue<T>

§

impl<T> RefUnwindSafe for WeightedFairQueue<T>
where T: RefUnwindSafe,

§

impl<T> Send for WeightedFairQueue<T>
where T: Send,

§

impl<T> Sync for WeightedFairQueue<T>
where T: Sync,

§

impl<T> Unpin for WeightedFairQueue<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for WeightedFairQueue<T>

§

impl<T> UnwindSafe for WeightedFairQueue<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more