Struct BandwidthAllocation 

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

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

impl BandwidthAllocation

pub fn new(total_bandwidth_bps: u64) -> BandwidthAllocation

Create a new bandwidth allocation with specified total bandwidth

pub fn default_tactical() -> BandwidthAllocation

Create default tactical allocation for 1 Mbps link

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

pub fn default_standard() -> BandwidthAllocation

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

pub fn default_high_bandwidth() -> BandwidthAllocation

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

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.

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.

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.

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.

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

Get the quota configuration for a class

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

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

pub async fn total_utilization(&self) -> f64

Get overall bandwidth utilization

pub async fn available_bandwidth_bps(&self) -> u64

Get available bandwidth in bits per second

pub fn active_permit_count(&self) -> u64

Get number of active permits

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

Get all class utilizations

Trait Implementations

impl Debug for BandwidthAllocation

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

Formats the value using the given formatter.