Struct WebSocketConnection 

pub struct WebSocketConnection {
    pub id: ConnectionId,
    /* private fields */
}

WebSocket connection wrapper - clean API over tokio-tungstenite

Fields

id: ConnectionId

Unique connection identifier

Implementations

impl WebSocketConnection

pub async fn from_stream<S>( stream: S, config: WebSocketConfig, ) -> WebSocketResult<Self>

where S: AsyncRead + AsyncWrite + Unpin + Send + 'static,

Create a new WebSocket connection from a TCP stream

pub async fn send(&self, message: WebSocketMessage) -> WebSocketResult<()>

Send a message to the WebSocket

pub async fn send_text<T: Into<String>>(&self, text: T) -> WebSocketResult<()>

Send a text message

pub async fn send_binary<T: Into<Vec<u8>>>( &self, data: T, ) -> WebSocketResult<()>

Send a binary message

pub async fn ping<T: Into<Vec<u8>>>(&self, data: T) -> WebSocketResult<()>

Send a ping

pub async fn close(&self) -> WebSocketResult<()>

Close the connection

pub async fn close_with_reason( &self, code: u16, reason: String, ) -> WebSocketResult<()>

Close the connection with a reason

pub async fn state(&self) -> ConnectionState

Get the current connection state

pub async fn is_active(&self) -> bool

Check if the connection is active

pub async fn is_closed(&self) -> bool

Check if the connection is closed

pub async fn metadata(&self) -> ConnectionMetadata

Get connection metadata

pub async fn set_metadata(&self, key: String, value: String)

Update connection metadata

pub async fn stats(&self) -> ConnectionStats

Get connection statistics

Trait Implementations

impl Clone for WebSocketConnection

fn clone(&self) -> WebSocketConnection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for WebSocketConnection

fn drop(&mut self)

Executes the destructor for this type.