Struct Relay

pub struct Relay { /* private fields */ }

A running instance of a Pkarr relay server.

This struct represents a running relay server and provides methods to interact with it, such as retrieving the server’s address or shutting it down.

Implementations

impl Relay

pub fn builder() -> RelayBuilder

Create a builder for running a Relay

pub async unsafe fn run_with_config_file( config_path: impl AsRef<Path>, ) -> Result<Self>

Run a Relay with a configuration file path.

Safety

Homeserver uses LMDB, opening which is marked unsafe, because the possible Undefined Behavior (UB) if the lock file is broken.

pub async fn run_test(testnet: &Testnet) -> Result<Self>

Run an ephemeral Pkarr relay on a random port number for testing purposes.

Arguments

• testnet - A reference to a mainline::Testnet for bootstrapping the DHT.

Safety

Homeserver uses LMDB, opening which is marked unsafe, because the possible Undefined Behavior (UB) if the lock file is broken.

pub async unsafe fn run_testnet() -> Result<Self>

Run a Pkarr relay in a Testnet mode (on port 15411).

Safety

Homeserver uses LMDB, opening which is marked unsafe, because the possible Undefined Behavior (UB) if the lock file is broken.

pub fn relay_address(&self) -> SocketAddr

Returns the HTTP socket address of the relay.

pub fn local_url(&self) -> Url

Returns the localhost URL of the HTTP server.

pub fn shutdown(&self)

Shutdown the relay server.