Struct IpcServerBuilder 

pub struct IpcServerBuilder<RpcMiddleware> { /* private fields */ }

Available on crate feature rpc only.

Builder to configure and create a JSON-RPC server

Implementations

impl<RpcMiddleware> Builder<RpcMiddleware>

pub const fn max_request_body_size(self, size: u32) -> Builder<RpcMiddleware>

Set the maximum size of a request body in bytes. Default is 10 MiB.

pub const fn max_response_body_size(self, size: u32) -> Builder<RpcMiddleware>

Set the maximum size of a response body in bytes. Default is 10 MiB.

pub const fn max_connections(self, max: u32) -> Builder<RpcMiddleware>

Set the maximum number of connections allowed. Default is 100.

pub const fn max_subscriptions_per_connection( self, max: u32, ) -> Builder<RpcMiddleware>

Set the maximum number of subscriptions per connection. Default is 1024.

pub fn custom_tokio_runtime(self, rt: Handle) -> Builder<RpcMiddleware>

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

Default: [tokio::spawn]

pub fn set_ipc_socket_permissions( self, permissions: Option<String>, ) -> Builder<RpcMiddleware>

Sets the permissions for the IPC socket file.

On Unix, accepts an octal mode up to 0o7777 with an optional 0o prefix. Invalid modes or failures to apply them cause IpcServer::start to return an error. This includes platforms that do not support setting socket permissions before binding. None uses the system’s umask. Ignored on non-Unix platforms.

pub fn set_id_provider<I>(self, id_provider: I) -> Builder<RpcMiddleware>

where I: IdProvider + 'static,

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::server::RandomStringIdProvider;
use reth_ipc::server::Builder;

// static dispatch
let builder1 = Builder::default().set_id_provider(RandomStringIdProvider::new(16));

// or dynamic dispatch
let builder2 = Builder::default().set_id_provider(Box::new(RandomStringIdProvider::new(16)));

pub fn set_rpc_middleware<T>( self, rpc_middleware: RpcServiceBuilder<T>, ) -> Builder<T>

Enable middleware that is invoked on every JSON-RPC call.

The middleware itself is very similar to the tower middleware but it has a different service trait which takes &self instead &mut self which means that you can’t use built-in middleware from tower.

Another consequence of &self is that you must wrap any of the middleware state in a type which is Send and provides interior mutability such Arc<Mutex>.

The builder itself exposes a similar API as the [tower::ServiceBuilder] where it is possible to compose layers to the middleware.

pub fn build(self, endpoint: String) -> IpcServer<RpcMiddleware>

Finalize the configuration of the server. Consumes the Builder.

Trait Implementations

impl<RpcMiddleware> Debug for Builder<RpcMiddleware>

where RpcMiddleware: Debug,

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

Formats the value using the given formatter.

impl Default for Builder<Identity>

fn default() -> Builder<Identity>

Returns the “default value” for a type.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.