Struct iroh_relay::server::Server

pub struct Server { /* private fields */ }

Available on crate feature server only.

A running Relay + STUN server.

This is a full Relay server, including STUN, Relay and various associated HTTP services.

Dropping this will stop the server.

Implementations

impl Server

pub async fn spawn<EC, EA>(config: ServerConfig<EC, EA>) -> Result<Self>

where EC: Debug + 'static, EA: Debug + 'static,

Starts the server.

pub async fn shutdown(self) -> Result<()>

Requests graceful shutdown.

Returns once all server tasks have stopped.

pub fn task_handle(&mut self) -> &mut AbortOnDropHandle<Result<()>>

Returns the handle for the task.

This allows waiting for the server’s supervisor task to finish. Can be useful in case there is an error in the server before it is shut down.

pub fn https_addr(&self) -> Option<SocketAddr>

The socket address the HTTPS server is listening on.

pub fn http_addr(&self) -> Option<SocketAddr>

The socket address the HTTP server is listening on.

pub fn quic_addr(&self) -> Option<SocketAddr>

The socket address the QUIC server is listening on.

pub fn stun_addr(&self) -> Option<SocketAddr>

The socket address the STUN server is listening on.

pub fn certificates(&self) -> Option<Vec<CertificateDer<'static>>>

The certificates chain if configured with manual TLS certificates.

pub fn https_url(&self) -> Option<RelayUrl>

Get the server’s https RelayUrl.

This uses Self::https_addr so it’s mostly useful for local development.

pub fn http_url(&self) -> Option<RelayUrl>

Get the server’s http RelayUrl.

This uses Self::http_addr so it’s mostly useful for local development.

Trait Implementations

impl Debug for Server

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

Formats the value using the given formatter.