Struct FlowController 

pub struct FlowController { /* private fields */ }

Flow control for hierarchical message routing

Provides bandwidth limiting and backpressure for cell and zone level routing.

Implementations

impl FlowController

pub fn new( cell_limit: BandwidthLimit, zone_limit: BandwidthLimit, drop_policy: MessageDropPolicy, ) -> Self

Create a new flow controller

pub async fn acquire_permit( &self, level: RoutingLevel, message_size: usize, priority: MessagePriority, ) -> Result<Permit>

Acquire permit to send a message

This will block if rate limits are exceeded, applying backpressure.

pub async fn has_backpressure(&self) -> bool

Check if backpressure is currently active

pub async fn acquire_permit_qos( &self, level: RoutingLevel, message_size: usize, qos_class: QoSClass, ) -> Result<Permit>

Acquire permit using QoSClass instead of MessagePriority

This method provides QoS-aware flow control by converting QoSClass to MessagePriority for the underlying rate limiter. Higher QoS classes (Critical, High) receive preferential treatment with lower token consumption.

Arguments

• level - The routing level (Cell or Zone)
• message_size - Size of the message in bytes
• qos_class - The QoS classification for priority handling

Example

use peat_protocol::hierarchy::flow_control::{FlowController, RoutingLevel};
use peat_protocol::qos::QoSClass;

let controller = FlowController::new(/* ... */);
let permit = controller.acquire_permit_qos(
    RoutingLevel::Cell,
    1024,
    QoSClass::Critical,
).await?;

pub fn should_drop_qos(&self, qos_class: QoSClass) -> bool

Determine if a message should be dropped based on QoS class

Higher priority classes (Critical, High) are never dropped. Lower priority classes may be dropped under backpressure.

pub async fn release_backpressure(&self)

Release backpressure

pub fn should_drop(&self, priority: MessagePriority) -> bool

Determine if a message should be dropped based on policy

pub fn record_drop(&self)

Record a dropped message

pub fn get_metrics(&self) -> FlowMetrics

Get flow control metrics

pub async fn available_capacity(&self, level: RoutingLevel) -> CapacityInfo

Get current available capacity