Struct jsonrpc_ws_server::Server

pub struct Server { /* fields omitted */ }

WebSockets server implementation.

Implementations

impl Server

pub fn addr(&self) -> &SocketAddr

Returns the address this server is listening on

pub fn broadcaster(&self) -> Broadcaster

Returns a Broadcaster that can be used to send messages on all connections.

pub fn start<M: Metadata, S: Middleware<M>>(
    addr: &SocketAddr,
    handler: Arc<MetaIoHandler<M, S>>,
    meta_extractor: Arc<dyn MetaExtractor<M>>,
    allowed_origins: Option<Vec<Origin>>,
    allowed_hosts: Option<Vec<Host>>,
    request_middleware: Option<Arc<dyn RequestMiddleware>>,
    stats: Option<Arc<dyn SessionStats>>,
    executor: UninitializedExecutor,
    max_connections: usize,
    max_payload_bytes: usize,
    max_in_buffer_capacity: usize,
    max_out_buffer_capacity: usize
) -> Result<Server> where
    S::Future: Unpin,
    S::CallFuture: Unpin, 

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

impl Server

pub fn wait(self) -> Result<()>

Consumes the server and waits for completion

pub fn close(self)

Closes the server and waits for it to finish

pub fn close_handle(&self) -> CloseHandle

Returns a handle to the server that can be used to close it while another thread is blocking in wait.

Trait Implementations

impl Debug for Server

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

Formats the value using the given formatter.

impl Drop for Server

fn drop(&mut self)

Executes the destructor for this type.