Connection

Struct Connection 

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

Represents a WebSocket connection

Implementations§

Source§

impl Connection

Source

pub fn new(remote_addr: SocketAddr, local_addr: SocketAddr) -> Self

Create a new connection

Source

pub fn with_stream( remote_addr: SocketAddr, local_addr: SocketAddr, stream: Box<dyn TransportStream>, ) -> Self

Create a new connection with a transport stream

Source

pub fn with_timeout( remote_addr: SocketAddr, local_addr: SocketAddr, stream: Box<dyn TransportStream>, idle_timeout: Option<Duration>, ) -> Self

Create a new connection with timeout settings

Source

pub fn set_stream(&mut self, stream: Box<dyn TransportStream>)

Set the transport stream

Source

pub fn remote_addr(&self) -> SocketAddr

Get the remote address

Source

pub fn local_addr(&self) -> SocketAddr

Get the local address

Source

pub fn state(&self) -> ConnectionState

Get the connection state

Source

pub fn metadata(&self) -> &ConnectionMetadata

Get the connection metadata

Source

pub fn is_timed_out(&self) -> bool

Check if the connection has timed out

Source

pub fn time_until_timeout(&self) -> Option<Duration>

Get the time until the connection times out

Source

pub fn set_idle_timeout(&mut self, timeout: Option<Duration>)

Set the idle timeout

Source

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

Send a message

Source

pub async fn send_text(&mut self, text: impl AsRef<str>) -> Result<()>

Send a text message

Source

pub async fn send_binary(&mut self, data: impl Into<Bytes>) -> Result<()>

Send a binary message

Source

pub async fn ping(&mut self, data: Option<&[u8]>) -> Result<()>

Send a ping message

Source

pub async fn pong(&mut self, data: Option<&[u8]>) -> Result<()>

Send a pong message

Source

pub async fn send_pong(&mut self) -> Result<()>

Send a pong message (convenience method)

Source

pub async fn next(&mut self) -> Result<Option<Message>>

Receive the next message

Source

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

Close the connection

Source

pub fn is_connected(&self) -> bool

Check if the connection is established

Source

pub fn is_closed(&self) -> bool

Check if the connection is closed

Source

pub fn age(&self) -> Duration

Get the connection age

Source

pub fn idle_time(&self) -> Duration

Get the time since last activity

Trait Implementations§

Source§

impl Debug for Connection

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more