Struct jsonrpc_ws_server::ServerBuilder

pub struct ServerBuilder<M: Metadata, S: Middleware<M>> { /* fields omitted */ }

Builder for WebSockets server

Implementations

impl<M: Metadata + Default, S: Middleware<M>> ServerBuilder<M, S> where
    S::Future: Unpin,
    S::CallFuture: Unpin, 

pub fn new<T>(handler: T) -> Self where
    T: Into<MetaIoHandler<M, S>>, 

Creates new ServerBuilder

impl<M: Metadata, S: Middleware<M>> ServerBuilder<M, S> where
    S::Future: Unpin,
    S::CallFuture: Unpin, 

pub fn with_meta_extractor<T, E>(handler: T, extractor: E) -> Self where
    T: Into<MetaIoHandler<M, S>>,
    E: MetaExtractor<M>, 

Creates new ServerBuilder

pub fn event_loop_executor(mut self: Self, executor: TaskExecutor) -> Self

Utilize existing event loop executor to poll RPC results.

pub fn session_meta_extractor<T: MetaExtractor<M>>(
    mut self: Self,
    extractor: T
) -> Self

Sets a meta extractor.

pub fn allowed_origins(
    mut self: Self,
    allowed_origins: DomainsValidation<Origin>
) -> Self

Allowed origins.

pub fn allowed_hosts(
    mut self: Self,
    allowed_hosts: DomainsValidation<Host>
) -> Self

Allowed hosts.

pub fn session_stats<T: SessionStats>(mut self: Self, stats: T) -> Self

Session stats

pub fn request_middleware<T: RequestMiddleware>(
    mut self: Self,
    middleware: T
) -> Self

Sets a request middleware. Middleware will be invoked before each handshake request. You can either terminate the handshake in the middleware or run a default behaviour after.

pub fn max_connections(mut self: Self, max_connections: usize) -> Self

Maximal number of concurrent connections this server supports. Default: 100

pub fn max_payload(mut self: Self, max_payload_bytes: usize) -> Self

Maximal size of the payload (in bytes) Default: 5MB

pub fn max_in_buffer_capacity(
    mut self: Self,
    max_in_buffer_capacity: usize
) -> Self

The maximum size to which the incoming buffer can grow. Default: 10,485,760

pub fn max_out_buffer_capacity(
    mut self: Self,
    max_out_buffer_capacity: usize
) -> Self

The maximum size to which the outgoing buffer can grow. Default: 10,485,760

pub fn start(self, addr: &SocketAddr) -> Result<Server>

Starts a new WebSocket server in separate thread. Returns a Server handle which closes the server when droped.