Trait jsonrpsee_core::middleware::Middleware

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

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

    fn on_connect(&self) { ... }
    fn on_call(&self, _name: &str) { ... }
    fn on_result(&self, _name: &str, _success: bool, _started_at: Self::Instant) { ... }
    fn on_response(&self, _started_at: Self::Instant) { ... }
    fn on_disconnect(&self) { ... }
}

Defines a middleware with callbacks during the RPC request life-cycle. The primary use case for this is to collect timings for a larger metrics collection solution but the only constraints on the associated type is that it be Send and Copy, giving users some freedom to do what they need to do.

See the WsServerBuilder::set_middleware or the HttpServerBuilder::set_middleware method for examples.

Required Associated Types

type Instant: Send + 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_request(&self) -> Self::Instant

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

Provided Methods

fn on_connect(&self)

Called when a new client connects (WebSocket only)

fn on_call(&self, _name: &str)

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

fn on_result(&self, _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, _started_at: Self::Instant)

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

fn on_disconnect(&self)

Called when a client disconnects (WebSocket only)

Implementations on Foreign Types

impl Middleware for ()

type Instant = ()

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

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

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

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

fn on_call(&self, name: &str)

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

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

Implementors