Struct WebSocketHandler

pub struct WebSocketHandler { /* private fields */ }

Handle raw messages from a websocket.

Use WebSocketHandler to implement a Websocket server.

Implementations

impl WebSocketHandler

pub fn new(router: WebSocketRouter, max_in_flight: usize) -> Arc<Self>

Constructor.

max_in_flight limits the number of RPC/Subscription calls that can be in-flight at once. This stops clients spawning lots of tasks by blocking the websocket.

Subscriptions are only considered in-flight until they’ve sent their initial response to the client. To limit the active subscriptions, use a Semaphore or similar mechanism in the function that generates the Stream and hold an OwnedSemaphorePermit permit for the life of the stream.

pub async fn handle_socket<SocketSink, Incoming, Outgoing>( self: &Arc<Self>, outgoing: SocketSink, incoming: impl Stream<Item = Incoming>, ) -> Result<()>

where Incoming: AsRef<[u8]> + Send + Sync + 'static, Outgoing: From<Vec<u8>>, SocketSink: Sink<Outgoing> + Unpin, SocketSink::Error: Error,

pub async fn handle_msg( &self, msg: &[u8], result_sink: &Sender<Result<Vec<u8>>>, ) -> Result<()>

Handle a raw Websocket message.

This will read a MsgId from the message and route it to the correct implementation. Prefer using Self::handle_socket if it’s general enough.