Struct ConnectionHealthWatcher 

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

Available on crate feature net only.

Watcher that can update and read the ConnectionHealth

Note: this should only be added once to extensions and be used by all connection / health checks.

Install vs mark/read convention

A protocol implementation installing the watcher for a new logical connection must use self_get_ref_or_insert (this extensions level only): a transport forked off a consumed connection (e.g. a CONNECT tunnel from an upgraded h1 hop) must not adopt that connection’s health state through the parent chain. Marking and reading should use the walking get_ref/get_ref_or_insert, so they resolve to the watcher governing the connection at hand.

Whoever observes an event that makes a connection non-reusable (an abandoned mid-stream body, a cancelled in-flight request, a protocol error) must mark it broken synchronously with that event, before any guard releases the connection back to a pool: deferring the mark to a background connection task loses the race against the next request checking the connection out.

Implementations

impl ConnectionHealthWatcher

pub fn new() -> ConnectionHealthWatcher

pub fn install(extensions: &Extensions) -> &ConnectionHealthWatcher

Install the watcher for a new logical connection.

Inserts at this extensions level only (no parent walk), per the install-vs-mark convention above: use this from protocol handshakes, and the walking get_ref/get_ref_or_insert to read or mark.

pub fn mark_healthy(&self)

Set the ConnectionHealth to health

pub fn mark_broken(&self)

Set the ConnectionHealth to broken

pub fn update_health(&self, health: ConnectionHealth)

Set the ConnectionHealth

pub fn health(&self) -> ConnectionHealth

Get the ConnectionHealth

pub fn watch(&self) -> Changed<ConnectionHealth>

Subscribe to health changes: Changed::changed yields each new value.

Trait Implementations

impl Debug for ConnectionHealthWatcher

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

Formats the value using the given formatter.

impl Default for ConnectionHealthWatcher

fn default() -> ConnectionHealthWatcher

Returns the “default value” for a type.

impl Extension for ConnectionHealthWatcher

impl NetExtension for ConnectionHealthWatcher