Skip to main content

BackpressureController

Struct BackpressureController 

Source
pub struct BackpressureController { /* private fields */ }
Expand description

Backpressure controller for managing write queue pressure.

This controller uses atomic operations for lock-free tracking of pending frame counts. It can be shared across multiple threads/tasks.

Implementations§

Source§

impl BackpressureController

Source

pub fn new(max_pending: usize) -> Self

Create a new backpressure controller with specified limit.

Source

pub fn with_timeout(max_pending: usize, timeout: Duration) -> Self

Create a controller with custom timeout.

Source

pub fn from_shared( pending: Arc<AtomicUsize>, max_pending: usize, timeout: Duration, ) -> Self

Create from an existing atomic counter (for sharing with writer task).

Source

pub fn pending_counter(&self) -> Arc<AtomicUsize>

Get a clone of the pending counter Arc (for sharing).

Source

pub fn can_accept(&self) -> bool

Check if we can accept more frames without blocking.

Source

pub fn is_active(&self) -> bool

Check if backpressure is currently active.

Source

pub fn pending_count(&self) -> usize

Get current pending count.

Source

pub fn max_pending(&self) -> usize

Get maximum pending limit.

Source

pub fn available_capacity(&self) -> usize

Get available capacity.

Source

pub fn try_reserve(&self) -> Result<()>

Try to reserve a slot without blocking.

Returns Ok(()) if reserved, Err(BackpressureTimeout) if at capacity.

Source

pub async fn reserve(&self) -> Result<()>

Reserve a slot, waiting if necessary.

Returns Err(BackpressureTimeout) if timeout is reached.

Source

pub fn release(&self)

Release a slot (called after frame is written).

Source

pub fn release_many(&self, count: usize)

Release multiple slots at once (for batch writes).

Source

pub fn reset(&self)

Reset the pending count (use with caution).

Trait Implementations§

Source§

impl Clone for BackpressureController

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for BackpressureController

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for BackpressureController

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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<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