Struct OnDisconnectGuard 

pub struct OnDisconnectGuard { /* private fields */ }

Available on crate feature server only.

Reports a connection’s disconnect to AccessControl when dropped.

A guard is created the moment AccessControl::on_connect admits a connection, and is then held for the connection’s entire lifetime. Dropping it - whether the connection closed cleanly, hit an error, or setup returned early - calls AccessControl::on_disconnect exactly once.

Threading the guard through connection setup and into the connection actor makes it impossible to admit a connection without eventually reporting its disconnect, even as the surrounding code changes.

Embedders that register connections through Clients::register construct the guard themselves; see that method for the expected lifecycle.

Implementations

impl OnDisconnectGuard

pub fn for_access_control( access: Arc<dyn DynAccessControl>, request: &ClientRequest, ) -> Self

Creates a guard for the connection described by request.

Dropping the guard calls AccessControl::on_disconnect on access with the request’s EndpointId and ConnectionId. Create it only once AccessControl::on_connect has admitted the connection.

pub fn empty(endpoint_id: EndpointId) -> Self

Creates a no-op guard for endpoint_id.

The guard carries endpoint_id and a fresh ConnectionId but has no access control attached, so dropping it does nothing.

pub fn endpoint_id(&self) -> EndpointId

Returns the EndpointId of the guarded connection.

pub fn connection_id(&self) -> ConnectionId

Returns the ConnectionId of the guarded connection.

Trait Implementations

impl Debug for OnDisconnectGuard

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

Formats the value using the given formatter.

impl Drop for OnDisconnectGuard

fn drop(&mut self)

Executes the destructor for this type.