Struct Connection 

pub struct Connection<S = MaybeTlsStream<TcpStream>> { /* private fields */ }

WebSocket connection wrapper around a Tokio Tungstenite stream.

Implementations

impl<S> Connection<S>

where S: AsyncRead + AsyncWrite + Unpin,

pub async fn send(&mut self, msg: Message) -> Result<(), Error>

Send a text or binary message.

pub async fn recv(&mut self) -> Result<Message, Error>

Receive the next text or binary message, responding to pings as needed.

pub async fn close(&mut self) -> Result<(), Error>

Close the WebSocket connection gracefully.

pub fn get_ref(&self) -> &S

Borrow the underlying transport stream.

pub fn get_mut(&mut self) -> &mut S

Mutably borrow the underlying transport stream.

impl<S> Connection<S>

pub fn peer_addr(&self) -> SocketAddr

Return the peer address.

pub fn local_addr(&self) -> SocketAddr

Return the local address.

pub fn is_tls(&self) -> bool

Report whether TLS is in use.

pub fn info(&self) -> ConnectionInfo

Return the full connection metadata snapshot.

Trait Implementations

impl<S> WebSocketConnection for Connection<S>

where S: AsyncRead + AsyncWrite + Unpin,

fn send<'a>( &'a mut self, msg: Message, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'a>>

Send one message.

fn recv<'a>( &'a mut self, ) -> Pin<Box<dyn Future<Output = Result<Message, Error>> + 'a>>

Receive one message.

fn close<'a>( &'a mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + 'a>>

Close the connection gracefully.