Struct jsonrpsee_ws_server::WsServerBuilder
source · pub struct WsServerBuilder<M = ()> { /* private fields */ }
Expand description
Builder to configure and create a JSON-RPC Websocket server
Implementations§
source§impl<M> Builder<M>
impl<M> Builder<M>
sourcepub fn max_request_body_size(self, size: u32) -> Self
pub fn max_request_body_size(self, size: u32) -> Self
Set the maximum size of a request body in bytes. Default is 10 MiB.
sourcepub fn max_response_body_size(self, size: u32) -> Self
pub fn max_response_body_size(self, size: u32) -> Self
Set the maximum size of a response body in bytes. Default is 10 MiB.
sourcepub fn max_connections(self, max: u64) -> Self
pub fn max_connections(self, max: u64) -> Self
Set the maximum number of connections allowed. Default is 100.
sourcepub fn batch_requests_supported(self, supported: bool) -> Self
pub fn batch_requests_supported(self, supported: bool) -> Self
Enables or disables support of batch requests. By default, support is enabled.
sourcepub fn max_subscriptions_per_connection(self, max: u32) -> Self
pub fn max_subscriptions_per_connection(self, max: u32) -> Self
Set the maximum number of connections allowed. Default is 1024.
sourcepub fn register_resource(
self,
label: &'static str,
capacity: u16,
default: u16
) -> Result<Self, Error>
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.
sourcepub fn set_middleware<T: Middleware>(self, middleware: T) -> Builder<T>
pub fn set_middleware<T: Middleware>(self, middleware: T) -> Builder<T>
Add a middleware to the builder Middleware
.
use std::{time::Instant, net::SocketAddr};
use jsonrpsee_core::middleware::{WsMiddleware, Headers, MethodKind, Params};
use jsonrpsee_ws_server::WsServerBuilder;
#[derive(Clone)]
struct MyMiddleware;
impl WsMiddleware for MyMiddleware {
type Instant = Instant;
fn on_connect(&self, remote_addr: SocketAddr, headers: &Headers) {
println!("[MyMiddleware::on_call] remote_addr: {}, headers: {:?}", remote_addr, headers);
}
fn on_request(&self) -> Self::Instant {
Instant::now()
}
fn on_call(&self, method_name: &str, params: Params, kind: MethodKind) {
println!("[MyMiddleware::on_call] method: '{}' params: {:?}, kind: {:?}", method_name, params, kind);
}
fn on_result(&self, method_name: &str, success: bool, started_at: Self::Instant) {
println!("[MyMiddleware::on_result] '{}', worked? {}, time elapsed {:?}", method_name, success, started_at.elapsed());
}
fn on_response(&self, result: &str, started_at: Self::Instant) {
println!("[MyMiddleware::on_response] result: {}, time elapsed {:?}", result, started_at.elapsed());
}
fn on_disconnect(&self, remote_addr: SocketAddr) {
println!("[MyMiddleware::on_disconnect] remote_addr: {}", remote_addr);
}
}
let builder = WsServerBuilder::new().set_middleware(MyMiddleware);
sourcepub fn custom_tokio_runtime(self, rt: Handle) -> Self
pub fn custom_tokio_runtime(self, rt: Handle) -> Self
Configure a custom tokio::runtime::Handle
to run the server on.
Default: tokio::spawn
sourcepub fn ping_interval(self, interval: Duration) -> Self
pub fn ping_interval(self, interval: Duration) -> Self
Configure the interval at which pings are submitted.
This option is used to keep the connection alive, and is just submitting Ping
frames,
without making any assumptions about when a Pong
frame should be received.
Default: 60 seconds.
Examples
use std::time::Duration;
use jsonrpsee_ws_server::WsServerBuilder;
// Set the ping interval to 10 seconds.
let builder = WsServerBuilder::default().ping_interval(Duration::from_secs(10));
sourcepub fn set_id_provider<I: IdProvider + 'static>(self, id_provider: I) -> Self
pub fn set_id_provider<I: IdProvider + 'static>(self, id_provider: I) -> Self
Configure custom subscription ID
provider for the server to use
to when getting new subscription calls.
You may choose static dispatch or dynamic dispatch because
IdProvider
is implemented for Box<T>
.
Default: RandomIntegerIdProvider
.
Examples
use jsonrpsee_ws_server::{WsServerBuilder, RandomStringIdProvider, IdProvider};
// static dispatch
let builder1 = WsServerBuilder::default().set_id_provider(RandomStringIdProvider::new(16));
// or dynamic dispatch
let builder2 = WsServerBuilder::default().set_id_provider(Box::new(RandomStringIdProvider::new(16)));
sourcepub fn set_access_control(self, acl: AccessControl) -> Self
pub fn set_access_control(self, acl: AccessControl) -> Self
Sets access control settings.
sourcepub async fn build(self, addrs: impl ToSocketAddrs) -> Result<Server<M>, Error>
pub async fn build(self, addrs: impl ToSocketAddrs) -> Result<Server<M>, Error>
Finalize the configuration of the server. Consumes the Builder
.
#[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_ws_server::WsServerBuilder::default().build(occupied_addr).await.is_err());
assert!(jsonrpsee_ws_server::WsServerBuilder::default().build(addrs).await.is_ok());
}