Skip to main content

BandwidthAllocation

Struct BandwidthAllocation 

Source
pub struct BandwidthAllocation {
    pub total_bandwidth_bps: u64,
    /* private fields */
}
Expand description

Bandwidth allocation configuration for all QoS classes

Manages per-class bandwidth quotas and tracks real-time usage across all priority levels.

Fields§

§total_bandwidth_bps: u64

Total available bandwidth in bits per second

Implementations§

Source§

impl BandwidthAllocation

Source

pub fn new(total_bandwidth_bps: u64) -> Self

Create a new bandwidth allocation with specified total bandwidth

Source

pub fn default_tactical() -> Self

Create default tactical allocation for 1 Mbps link

Designed for constrained tactical radio links with emphasis on critical data delivery.

Source

pub fn default_standard() -> Self

Create allocation for 10 Mbps link (standard WiFi/LTE)

Source

pub fn default_high_bandwidth() -> Self

Create allocation for high-bandwidth link (100 Mbps+)

Source

pub fn can_transmit(&self, class: QoSClass, size_bytes: usize) -> bool

Check if transmission is allowed for a given class and size

Returns true if there is sufficient bandwidth available within the class quota and global limit.

Source

pub fn acquire( &self, class: QoSClass, size_bytes: usize, ) -> Option<BandwidthPermit>

Acquire a bandwidth permit

Returns a permit if bandwidth is available, None otherwise. The permit must be held while transmitting and will automatically track usage when dropped.

Source

pub async fn acquire_async( &self, class: QoSClass, size_bytes: usize, ) -> Option<BandwidthPermit>

Acquire a bandwidth permit (async version)

Async-safe version that properly awaits the token bucket lock.

Source

pub fn preempt_lower(&self, class: QoSClass) -> bool

Attempt to preempt lower priority transfers

Returns true if preemption is allowed and was successful. The caller should pause/cancel lower priority transfers.

Source

pub fn get_quota(&self, class: QoSClass) -> Option<&Arc<BandwidthQuota>>

Get the quota configuration for a class

Source

pub fn class_utilization(&self, class: QoSClass) -> f64

Get current utilization for a class (0.0 - 1.0+)

Source

pub async fn total_utilization(&self) -> f64

Get overall bandwidth utilization

Source

pub async fn available_bandwidth_bps(&self) -> u64

Get available bandwidth in bits per second

Source

pub fn active_permit_count(&self) -> u64

Get number of active permits

Source

pub fn all_utilizations(&self) -> HashMap<QoSClass, f64>

Get all class utilizations

Trait Implementations§

Source§

impl Debug for BandwidthAllocation

Source§

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

Formats the value using the given formatter. 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> 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> Same for T

Source§

type Output = T

Should always be Self
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