iroh-netbench 0.1.0

Application-level network benchmarking over a dedicated iroh QUIC connection
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

//! Network quality measurements over a dedicated iroh QUIC connection.
//!
//! This crate is intentionally independent from file transfer and diagnostics.

mod client;
mod config;
mod error;
mod event;
mod monitor;
mod protocol;
mod report;
mod scheduling;
mod statistics;
pub mod wire;

pub use client::{NetBenchClient, NetBenchTest};
pub use config::{NetBenchConfig, NetBenchProbeConfig};
pub use error::{Error, Result};
pub use event::{
    ConnectionInfo, ConnectionStage, LatencySample, LossSample, NetBenchEvent, ThroughputDirection,
    ThroughputSample,
};
pub use monitor::{
    ConnectionMetrics, MonitoredConnectionId, MonitoredConnectionState, SessionMetrics,
    SessionMonitor, SessionMonitorConfig,
};
pub use protocol::{NetBenchProtocol, NetBenchProtocolBuilder, ThroughputPolicy};
pub use report::{
    ConnectionReport, LatencyReport, LoadedLatencyReport, LossReport, NetBenchProbeReport,
    NetBenchReport, PathKind, ThroughputReport, TransportReport,
};

/// ALPN used by the benchmark protocol.
pub const NETBENCH_ALPN: &[u8] = b"/iroh/netbench/1";

/// Current wire protocol version.
///
/// Increment this only for an incompatible change to encoded messages or their semantics.
pub const PROTOCOL_VERSION: u16 = 1;

/// Current JSON/report schema version.
pub const SCHEMA_VERSION: u16 = 1;