Struct WebSocketConnection 

pub struct WebSocketConnection { /* private fields */ }

An upgraded connection. recv returns the client’s messages, answering pings and the closing handshake itself; send with the methods here or a WebSocketSender from sender, which another thread can use while this one waits in recv.

Implementations

impl WebSocketConnection

pub fn max_message_size(self, bytes: usize) -> Self

Refuse messages over bytes (default MAX_MESSAGE) with close code 1009.

pub fn sender(&self) -> WebSocketSender

A sender for this connection, for other threads.

pub fn send_text(&self, text: &str) -> Result<(), String>

Send a text message.

pub fn send_binary(&self, data: &[u8]) -> Result<(), String>

Send a binary message.

pub fn close(&self, code: u16, reason: &str) -> Result<(), String>

Start the closing handshake; recv then returns Ok(None) when the client answers.

pub fn recv(&mut self) -> Result<Option<Message>, String>

The next message; Ok(None) once the connection closed cleanly (the closing handshake done, whoever started it). Pings are answered and pongs dropped on the way. A protocol error — an unmasked frame, a bad fragment, invalid UTF-8, an oversized message — closes the connection with the matching code and is returned as Err, as is the client disappearing without a close frame.