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.

pub fn node_id(&self) -> &str

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

pub fn max_consecutive_errors(&self) -> usize

The configured consecutive-error limit for the serve loop.

pub fn serve_options(&self) -> ServeOptions

Build a [ServeOptions] from the endpoint’s stored configuration.

Platform adapters should call this instead of constructing ServeOptions manually so that all server-limit fields are forwarded consistently.

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

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

pub async fn close(&self)

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

If no serve loop is running, closes the endpoint immediately. The handle store (all registries) is freed when the last IrohEndpoint clone is dropped — no explicit unregister is needed.

pub async fn close_force(&self)

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

pub async fn wait_closed(&self)

Wait until this endpoint has been closed (either explicitly via close() / close_force(), or because the native QUIC stack shut down).

Returns immediately if already closed.

pub fn set_serve_handle(&self, handle: ServeHandle)

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

pub fn stop_serve(&self)

Signal the serve loop to stop accepting new connections.

Returns immediately — does NOT close the endpoint or drain in-flight requests. The handle is preserved so close() can still drain later.

pub async fn wait_serve_stop(&self)

Wait until the serve loop has fully exited (serve task drained and finished).

Returns immediately if serve() was never called.

pub fn raw(&self) -> &Endpoint

pub fn handles(&self) -> &HandleStore

Per-endpoint handle store.

pub fn max_header_size(&self) -> usize

Maximum byte size of an HTTP/1.1 head.

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 compression(&self) -> Option<&CompressionOptions>

Compression options, if the compression feature is enabled.

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.

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.