Struct IrohEndpoint 

pub struct IrohEndpoint { /* private fields */ }

A shared Iroh endpoint.

Clone-able (cheap Arc clone). All fetch and serve calls on the same node share one endpoint and therefore one stable QUIC identity.

Implementations

impl IrohEndpoint

pub async fn bind(opts: NodeOptions) -> Result<Self, CoreError>

Bind an Iroh endpoint with the supplied options.

impl IrohEndpoint

pub async fn close(&self)

Graceful close: signal the serve loop to stop accepting, wait for in-flight requests to drain, then close the QUIC endpoint.

pub async fn close_force(&self)

Immediate close: abort the serve loop with no drain period.

pub async fn wait_closed(&self)

Wait until this endpoint has been closed. Returns immediately if already closed.

pub fn set_serve_handle(&self, handle: ServeHandle)

Store a serve handle so that close() can drain it.

If stop_serve() was called before this (the JS abort raced ahead of the napi async setup), the handle is immediately shut down so the serve loop drains without a second stop_serve() call.

pub fn stop_serve(&self)

Signal the serve loop to stop accepting new connections.

pub async fn wait_serve_stop(&self)

Wait until the serve loop has fully exited.

pub fn subscribe_events(&self) -> Option<Receiver<TransportEvent>>

Take the transport event receiver, handing it off to a platform drain task. May only be called once per endpoint.

impl IrohEndpoint

pub fn endpoint_stats(&self) -> EndpointStats

Snapshot of current endpoint statistics.

All fields are point-in-time reads and may change between calls.

pub fn bound_sockets(&self) -> Vec<SocketAddr>

Returns the local socket addresses this endpoint is bound to.

pub fn node_addr(&self) -> NodeAddrInfo

Full node address: node ID + relay URL(s) + direct socket addresses.

pub fn home_relay(&self) -> Option<String>

Home relay URL, or None if not connected to a relay.

pub async fn peer_info(&self, node_id_b32: &str) -> Option<NodeAddrInfo>

Known addresses for a remote peer, or None if not in the endpoint’s cache.

pub async fn peer_stats(&self, node_id_b32: &str) -> Option<PeerStats>

Per-peer connection statistics.

Returns path information for each known transport address, including whether each path is via a relay or direct, and which is active.

pub fn subscribe_path_changes( &self, node_id_str: &str, ) -> UnboundedReceiver<PathInfo>

Subscribe to path changes for a specific peer.

Spawns a background watcher task the first time a given peer is subscribed. The watcher polls peer_stats() every 200 ms and emits on the returned channel whenever the active path changes.

impl IrohEndpoint

pub fn node_id(&self) -> &str

The node’s public key as a lowercase base32 string.

pub fn secret_key_bytes(&self) -> [u8; 32]

The node’s raw secret key bytes (32 bytes).

Security

These 32 bytes are the irrecoverable private key for this node. Anyone who obtains them can impersonate this node permanently. Never log, print, or include in error payloads. Encrypt at rest. Zeroize after use.

pub fn handles(&self) -> &HandleStore

Per-endpoint handle store.

pub fn sweep_now(&self)

Immediately run a TTL sweep on all handle registries.

pub fn max_header_size(&self) -> usize

Maximum byte size of an HTTP/1.1 head.

pub fn max_response_body_bytes(&self) -> usize

Maximum decompressed response-body bytes accepted per outgoing fetch.

pub fn compression(&self) -> Option<&CompressionOptions>

Compression options, if the compression feature is enabled.

pub fn raw(&self) -> &Endpoint

Access the raw Iroh endpoint.

Trait Implementations

impl Clone for IrohEndpoint

fn clone(&self) -> IrohEndpoint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.