Struct Clients 

pub struct Clients(/* private fields */);

Available on crate feature server only.

Registry of connected relay clients.

This type manages the collection of active client connections and handles routing messages between them.

Implementations

impl Clients

pub async fn shutdown(&self)

Shuts down all connected clients.

This method gracefully disconnects all active client connections managed by this registry. It will wait for all clients to complete their shutdown before returning.

pub fn register<S>(&self, client_config: Config<S>, metrics: Arc<Metrics>)

where S: BytesStreamSink + Send + 'static,

Builds the client handler and starts the read & write loops for the connection.

Once the client disconnects, the OnDisconnectGuard set in config will be dropped, allowing callers to be notified of the disconnect.

pub fn disconnect( &self, endpoint_id: EndpointId, connection_id: Option<ConnectionId>, ) -> bool

Disconnects connections registered for endpoint_id.

With Some(connection_id), disconnects only that connection (active or an inactive duplicate). With None, disconnects every connection for the endpoint. Returns true if a matching connection was found, or false otherwise.

Shutdown happens asynchronously: each per-connection actor exits its run loop and unregisters itself after this call returns.

Trait Implementations

impl Clone for Clients

fn clone(&self) -> Clients

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Clients

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

Formats the value using the given formatter.

impl Default for Clients

fn default() -> Clients

Returns the “default value” for a type.