Struct WsConnection 

pub struct WsConnection<F> { /* private fields */ }

An established WebSocket client connection.

This value retains the opening-handshake response, the WebSocket codec, and the underlying I/O stream.

Implementations

impl<F> WsConnection<F>

pub fn codec(&self) -> &Codec

Returns the connection’s WebSocket codec.

pub fn response(&self) -> &ClientResponse

Returns the opening-handshake response.

impl<F> WsConnection<F>

pub fn sink(&self) -> WsSink

Returns a sink for sending messages over this connection.

All sinks of a connection share the same state, so a message cannot be sent through any of them once one has sent a close message.

pub fn into_inner(self) -> (Io<F>, Codec, ClientResponse)

Consumes the connection and returns its I/O stream, codec, and opening-handshake response.

impl WsConnection<Sealed>

pub fn receiver(self) -> Receiver<Result<Frame, WsError<()>>>

Starts the WebSocket dispatcher and returns a channel of received frames.

The dispatcher runs in a spawned task. Protocol and connection errors are delivered through the returned channel. A close frame from the peer is answered automatically, unless a close message has already been sent through a sink of this connection. Dropping the receiver sends a close frame and closes the connection once the peer responds or the closing-handshake timeout expires.

pub async fn start<T>( self, svc: impl IntoService<T, (), Frame>, ) -> Result<(), WsError<T::Error>>

where T: Service<(), Frame, Res = Option<Message>> + 'static,

Runs the WebSocket dispatcher with svc handling received frames.

The service may return a message to send to the peer or None when no response is required.

impl<F: Filter> WsConnection<F>

pub fn seal(self) -> WsConnection<Sealed>

Erases the concrete I/O filter type.

pub fn into_transport(self) -> Io<Layer<WsTransport, F>>

Converts the connection into a binary WebSocket transport.

Trait Implementations

impl<F> Debug for WsConnection<F>

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

Formats the value using the given formatter.