Struct openethereum::rpc::WsServer

pub struct WsServer {
    addr: SocketAddr,
    handle: Option<JoinHandle<Result<(), Error>>>,
    executor: Arc<Mutex<Option<Executor>>>,
    broadcaster: Sender,
}

WebSockets server implementation.

Fields

addr: SocketAddr

handle: Option<JoinHandle<Result<(), Error>>>

executor: Arc<Mutex<Option<Executor>>>

broadcaster: Sender

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, S>(
    addr: &SocketAddr,
    handler: Arc<MetaIoHandler<M, S>>,
    meta_extractor: Arc<dyn MetaExtractor<M> + 'static>,
    allowed_origins: Option<Vec<Origin, Global>>,
    allowed_hosts: Option<Vec<Host, Global>>,
    request_middleware: Option<Arc<dyn RequestMiddleware + 'static>>,
    stats: Option<Arc<dyn SessionStats + 'static>>,
    executor: UninitializedExecutor,
    max_connections: usize,
    max_payload_bytes: usize
) -> Result<Server, Error> where
    M: Metadata,
    S: Middleware<M>, 

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<(), Error>

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

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

Formats the value using the given formatter.

impl Drop for Server

pub fn drop(&mut self)

Executes the destructor for this type.