Struct sc_rpc_server::middleware::RpcMiddleware

pub struct RpcMiddleware { /* private fields */ }

Middleware for RPC calls

Implementations

impl RpcMiddleware

pub fn new(metrics: RpcMetrics, transport_label: &'static str) -> Self

Create a new RpcMiddleware with the provided RpcMetrics.

Trait Implementations

impl Clone for RpcMiddleware

fn clone(&self) -> RpcMiddleware

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl HttpMiddleware for RpcMiddleware

type Instant = Instant

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.

fn on_request(
    &self,
    _remote_addr: SocketAddr,
    _headers: &Headers
) -> Self::Instant

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

fn on_call(&self, 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, 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.

impl WsMiddleware for RpcMiddleware

type Instant = Instant

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.

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, 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, 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