Skip to main content

Module endpoint

Module endpoint 

Source
Expand description

Iroh endpoint lifecycle — create, share, and close.

IrohEndpoint is a thin façade over [EndpointInner], which is composed of the four named subsystems from ADR-014 D1:

  • [transport::Transport] — raw QUIC endpoint and stable identity.
  • [http_runtime::HttpRuntime] — pool, HTTP limits, in-flight counters.
  • [session_runtime::SessionRuntime] — serve loop, lifecycle signals, transport events, path subscriptions.
  • [ffi_bridge::FfiBridge] — the opaque-handle store reachable from JS.

No business logic lives in this module — only orchestration and the public API surface. Sub-modules:

  • [bind] — IrohEndpoint::bind() constructor.
  • [observe] — observability and peer-info methods.
  • configNodeOptions and friends.
  • stats — snapshot and event types.

Re-exports§

pub use config::DiscoveryOptions;
pub use config::NetworkingOptions;
pub use config::NodeOptions;
pub use config::PoolOptions;
pub use config::StreamingOptions;
pub use stats::ConnectionEvent;
pub use stats::EndpointStats;
pub use stats::NodeAddrInfo;
pub use stats::PathInfo;
pub use stats::PeerStats;

Modules§

config
Node configuration types passed to super::IrohEndpoint::bind.
stats
Endpoint observability types — snapshots, events, peer statistics.

Structs§

CompressionOptions
Compression options for response bodies (server) and outgoing requests (client; reserved).
IrohEndpoint
A shared Iroh endpoint.

Functions§

parse_direct_addrs
Parse an optional list of socket address strings into SocketAddr values.