Trait jsonrpsee_core::middleware::WsMiddleware

pub trait WsMiddleware: Send + Sync + Clone + 'static {
    type Instant: Debug + Send + Sync + Copy;

    fn on_connect(&self, remote_addr: SocketAddr, headers: &Headers);
    fn on_request(&self) -> Self::Instant;
    fn on_call(&self, method_name: &str, params: Params<'_>, kind: MethodKind);
    fn on_result(
        &self,
        method_name: &str,
        success: bool,
        started_at: Self::Instant
    );
    fn on_response(&self, result: &str, started_at: Self::Instant);
    fn on_disconnect(&self, remote_addr: SocketAddr);
}

Defines a middleware specifically for WebSocket connections with callbacks during the RPC request life-cycle. The primary use case for this is to collect timings for a larger metrics collection solution.

See the WsServerBuilder::set_middleware for examples.

Required Associated Types

type Instant: Debug + Send + Sync + Copy

Intended to carry timestamp of a request, for example std::time::Instant. How the middleware measures time, if at all, is entirely up to the implementation.

Required Methods

fn on_connect(&self, remote_addr: SocketAddr, headers: &Headers)

Called when a new client connects

fn on_request(&self) -> Self::Instant

Called when a new JSON-RPC request comes to the server.

fn on_call(&self, method_name: &str, params: Params<'_>, kind: MethodKind)

Called on each JSON-RPC method call, batch requests will trigger on_call multiple times.

fn on_result(&self, method_name: &str, success: bool, started_at: Self::Instant)

Called on each JSON-RPC method completion, batch requests will trigger on_result multiple times.

fn on_response(&self, result: &str, started_at: Self::Instant)

Called once the JSON-RPC request is finished and response is sent to the output buffer.

fn on_disconnect(&self, remote_addr: SocketAddr)

Called when a client disconnects

Implementations on Foreign Types

impl WsMiddleware for ()

type Instant = ()

fn on_connect(&self, _: SocketAddr, _: &Headers)

fn on_request(&self) -> Self::Instant

fn on_call(&self, _: &str, _: Params<'_>, _: MethodKind)

fn on_result(&self, _: &str, _: bool, _: Self::Instant)

fn on_response(&self, _: &str, _: Self::Instant)

fn on_disconnect(&self, _: SocketAddr)

impl<A, B> WsMiddleware for (A, B)where
    A: WsMiddleware,
    B: WsMiddleware,

type Instant = (<A as WsMiddleware>::Instant, <B as WsMiddleware>::Instant)

fn on_connect(&self, remote_addr: SocketAddr, headers: &Headers)

fn on_request(&self) -> Self::Instant

fn on_call(&self, method_name: &str, params: Params<'_>, kind: MethodKind)

fn on_result(&self, method_name: &str, success: bool, started_at: Self::Instant)

fn on_response(&self, result: &str, started_at: Self::Instant)

fn on_disconnect(&self, remote_addr: SocketAddr)

Implementors