tungstenite::protocol

Struct WebSocketContext

Source
pub struct WebSocketContext { /* private fields */ }
Expand description

A context for managing WebSocket stream.

Implementations§

Source§

impl WebSocketContext

Source

pub fn new(role: Role, config: Option<WebSocketConfig>) -> Self

Create a WebSocket context that manages a post-handshake stream.

§Panics

Panics if config is invalid e.g. max_write_buffer_size <= write_buffer_size.

Source

pub fn from_partially_read( part: Vec<u8>, role: Role, config: Option<WebSocketConfig>, ) -> Self

Create a WebSocket context that manages an post-handshake stream.

§Panics

Panics if config is invalid e.g. max_write_buffer_size <= write_buffer_size.

Source

pub fn set_config(&mut self, set_func: impl FnOnce(&mut WebSocketConfig))

Change the configuration.

§Panics

Panics if config is invalid e.g. max_write_buffer_size <= write_buffer_size.

Source

pub fn get_config(&self) -> &WebSocketConfig

Read the configuration.

Source

pub fn can_read(&self) -> bool

Check if it is possible to read messages.

Reading is impossible after receiving Message::Close. It is still possible after sending close frame since the peer still may send some data before confirming close.

Source

pub fn can_write(&self) -> bool

Check if it is possible to write messages.

Writing gets impossible immediately after sending or receiving Message::Close.

Source

pub fn read<Stream>(&mut self, stream: &mut Stream) -> Result<Message>
where Stream: Read + Write,

Read a message from the provided stream, if possible.

This function sends pong and close responses automatically. However, it never blocks on write.

Source

pub fn write<Stream>( &mut self, stream: &mut Stream, message: Message, ) -> Result<()>
where Stream: Read + Write,

Write a message to the provided stream.

A subsequent call should be made to flush to flush writes.

In the event of stream write failure the message frame will be stored in the write buffer and will try again on the next call to write or flush.

If the write buffer would exceed the configured WebSocketConfig::max_write_buffer_size Err(WriteBufferFull(msg_frame)) is returned.

Source

pub fn flush<Stream>(&mut self, stream: &mut Stream) -> Result<()>
where Stream: Read + Write,

Flush writes.

Ensures all messages previously passed to write and automatically queued pong responses are written & flushed into the stream.

Source

pub fn close<Stream>( &mut self, stream: &mut Stream, code: Option<CloseFrame<'_>>, ) -> Result<()>
where Stream: Read + Write,

Close the connection.

This function guarantees that the close frame will be queued. There is no need to call it again. Calling this function is the same as calling send(Message::Close(..)).

Trait Implementations§

Source§

impl Debug for WebSocketContext

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V