Struct tokio_websockets::server::Builder

pub struct Builder { /* private fields */ }

Available on crate feature server only.

Builder for WebSocket server connections.

Implementations

impl Builder

pub fn new() -> Self

Creates a Builder that can be used to create a WebSocketStream to receive messages at the server end.

pub fn config(self, config: Config) -> Self

Sets the configuration for the WebSocket stream.

pub fn limits(self, limits: Limits) -> Self

Sets the limits for the WebSocket stream.

pub async fn accept<S: AsyncRead + AsyncWrite + Unpin>( &self, stream: S, ) -> Result<WebSocketStream<S>, Error>

Perform a HTTP upgrade handshake on an already established stream and uses it to send and receive WebSocket messages.

Errors

This method returns an Error if the handshake fails.

pub fn serve<S: AsyncRead + AsyncWrite + Unpin>( &self, stream: S, ) -> WebSocketStream<S>

Takes over an already established stream and uses it to send and receive WebSocket messages.

This does not perform a HTTP upgrade handshake.

Trait Implementations

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.