Struct MessageRateMonitor 

pub struct MessageRateMonitor { /* private fields */ }

Message rate monitor for detecting high-frequency message scenarios.

This utility helps backends detect when message rates exceed a threshold and log warnings as specified in FR-016. It does not perform any automatic throttling or backpressure - it only logs warnings for user awareness.

Usage

Backends can use this to monitor receive rates:

use canlink_hal::backend::MessageRateMonitor;

let mut monitor = MessageRateMonitor::new(1000); // Warn above 1000 msg/s

// In receive loop:
if let Some(msg) = backend.receive_message()? {
    monitor.record_message();
    process(msg);
}

Thread Safety

This struct is not thread-safe. Each thread should have its own monitor or use external synchronization.

Implementations

impl MessageRateMonitor

pub fn new(threshold_per_second: u32) -> Self

Create a new message rate monitor.

Arguments

• threshold_per_second - Message rate threshold that triggers warnings

Examples

use canlink_hal::backend::MessageRateMonitor;

// Warn when rate exceeds 1000 messages/second
let monitor = MessageRateMonitor::new(1000);

pub fn record_message(&mut self) -> bool

Record a message and check if rate exceeds threshold.

Returns true if the rate exceeds the threshold (warning should be logged). Only returns true once per measurement window to avoid log spam.

Examples

use canlink_hal::backend::MessageRateMonitor;

let mut monitor = MessageRateMonitor::new(1000);

// Record messages
if monitor.record_message() {
    // Rate exceeded threshold - handle warning
    eprintln!("Warning: High message rate detected");
}

pub fn current_count(&self) -> u32

Get the current message count in this window.

pub fn threshold(&self) -> u32

Get the configured threshold.

pub fn reset(&mut self)

Reset the monitor state.

Trait Implementations

impl Debug for MessageRateMonitor

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

Formats the value using the given formatter.

impl Default for MessageRateMonitor

fn default() -> Self

Create a monitor with default threshold of 10000 messages/second.