Struct KeepTunnel 

pub struct KeepTunnel { /* private fields */ }

Keeps an HTTP/2 WebSocket connection out of its idle timer.

Over HTTP/2, a WebSocket is a CONNECT stream. The server counts the connection as busy while the request holds a tunnel mark. A handler on axum’s own WebSocketUpgrade drops that mark after the handshake, so keep_alive_timeout_ms closes the connection while the socket is open. Extract KeepTunnel and keep it for the life of the socket. autumn_web::ws::WebSocketUpgrade does this for you.

It never rejects. On HTTP/1, or for a request that is not CONNECT, it holds nothing.

use autumn_web::http_server::KeepTunnel;

async fn raw(tunnel: KeepTunnel, ws: axum::extract::ws::WebSocketUpgrade)
    -> axum::response::Response
{
    ws.on_upgrade(move |mut socket| async move {
        let _tunnel = tunnel; // drop it when the socket closes
        while let Some(Ok(_)) = socket.recv().await {}
    })
}

Trait Implementations

impl Debug for KeepTunnel

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

Formats the value using the given formatter.

impl<S: Send + Sync> FromRequestParts<S> for KeepTunnel

type Rejection = !

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, _state: &S, ) -> Result<Self, Infallible>

Perform the extraction.