Struct Serving 

pub struct Serving<S> { /* private fields */ }

A serving loop on a background task: the SDKs’ tunnel and port-forward handles.

Dropping it stops the loop and cuts the connections still open, so no relay outlives the handle that owns it: a relay carries the VM’s credentials to whoever connected.

Implementations

impl<S> Serving<S>

where S: Clone + Send + 'static,

pub fn local_address(&self) -> SocketAddr

The address the loop listens on, with the port the OS picked for a port 0.

pub fn is_running(&self) -> bool

Whether the loop is still serving, or waiting for its open connections to end.

pub fn request_stop(&self)

Asks the loop to stop accepting. Idempotent; Self::finished waits for it, and for the connections still open.

pub async fn stop(&self, grace: Option<Duration>) -> Result<S, Error>

Stops accepting and waits for the connections still open to end, cutting the ones still open after grace when it’s given, and returns what the loop did.

Without a grace, a client that keeps its connection open keeps this waiting: the relay holds bytes that client may still be reading, so the loop won’t cut it unasked.

pub async fn finished(&self) -> Result<S, Error>

Waits for the loop to end and returns what it did. Callable any number of times.