Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Build a Client.

Implementations

impl ClientBuilder

pub fn new( url: impl Into<RelayUrl>, secret_key: SecretKey, dns_resolver: DnsResolver, ) -> Self

Create a new ClientBuilder

pub fn tls_client_config(self, tls_config: ClientConfig) -> Self

Sets a custom TLS config.

This is a required option.

You can construct a [rustls::ClientConfig] by combining a [rustls::crypto::CryptoProvider] with a tls::CaTlsConfig using tls::CaTlsConfig::client_config, for example:

use std::sync::Arc;

use iroh_relay::tls::CaTlsConfig;

let crypto_provider: rustls::crypto::CryptoProvider = todo!();
let client_config = CaTlsConfig::default().client_config(Arc::new(crypto_provider));

If you enable the tls-ring or tls-aws-lc-rs feature, you can use the enabled crypto provider by using tls::default_provider.

pub fn address_family_selector<S>(self, selector: S) -> Self

where S: Fn() -> bool + Send + Sync + 'static,

Sets a callback hinting whether to prefer IPv6 when dialing the relay.

The callback runs on each dial. When it returns true, IPv6 addresses are tried first and IPv4 dials are held back slightly, biasing the happy-eyeballs race towards IPv6; when it returns false, IPv4 is preferred. Only return true when IPv6 is expected to work, since otherwise the bias just delays the connection.

pub fn proxy_url(self, url: Url) -> Self

Set an explicit proxy url to proxy all HTTP(S) traffic through.

pub fn auth_token(self, token: impl Into<String>) -> Self

Sets an authorization token.

On native targets, the token is sent as an Authorization: Bearer TOKEN header on the WebSocket upgrade request that establishes the relay connection. The token must be a valid HTTP header field value, if not Self::connect will return ConnectError::InvalidAuthToken.

When compiled to WebAssembly the token is sent as a ?token=TOKEN query parameter on the upgrade URL, since browsers don’t allow setting headers on WebSocket requests.

pub fn key_cache_capacity(self, capacity: usize) -> Self

Set the capacity of the cache for public keys.

pub async fn connect(&self) -> Result<Client, ConnectError>

Available on non-wasm_browser only.

Establishes a new connection to the relay server.

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> ClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.