Struct jsonrpsee_http_server::HttpServerBuilder

pub struct HttpServerBuilder<M = ()> { /* fields omitted */ }

Builder to create JSON-RPC HTTP server.

Implementations

impl Builder

pub fn new() -> Self

Create a default server builder.

impl<M> Builder<M>

pub fn set_middleware<T: Middleware>(self, middleware: T) -> Builder<T>

Add a middleware to the builder Middleware.

use std::time::Instant;

use jsonrpsee_core::middleware::Middleware;
use jsonrpsee_http_server::HttpServerBuilder;

#[derive(Clone)]
struct MyMiddleware;

impl Middleware for MyMiddleware {
    type Instant = Instant;

    fn on_request(&self) -> Instant {
        Instant::now()
    }

    fn on_result(&self, name: &str, success: bool, started_at: Instant) {
        println!("Call to '{}' took {:?}", name, started_at.elapsed());
    }
}

let builder = HttpServerBuilder::new().set_middleware(MyMiddleware);

pub fn max_request_body_size(self, size: u32) -> Self

Sets the maximum size of a request body in bytes (default is 10 MiB).

pub fn set_access_control(self, acl: AccessControl) -> Self

Sets access control settings.

pub fn keep_alive(self, keep_alive: bool) -> Self

Enables or disables HTTP keep-alive.

Default is true.

pub fn register_resource(
    self,
    label: &'static str,
    capacity: u16,
    default: u16
) -> Result<Self, Error>

Register a new resource kind. Errors if label is already registered, or if the number of registered resources on this server instance would exceed 8.

See the module documentation for resurce_limiting for details.

pub fn custom_tokio_runtime(self, rt: Handle) -> Self

Configure a custom tokio::runtime::Handle to run the server on.

Default: tokio::spawn

pub fn build(self, addrs: impl ToSocketAddrs) -> Result<Server<M>, Error>

Finalizes the configuration of the server.

#[tokio::main]
async fn main() {
  let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
  let occupied_addr = listener.local_addr().unwrap();
  let addrs: &[std::net::SocketAddr] = &[
      occupied_addr,
      "127.0.0.1:0".parse().unwrap(),
  ];
  assert!(jsonrpsee_http_server::HttpServerBuilder::default().build(occupied_addr).is_err());
  assert!(jsonrpsee_http_server::HttpServerBuilder::default().build(addrs).is_ok());
}

Trait Implementations

impl<M: Debug> Debug for Builder<M>

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.