Skip to main content

WsListener

Struct WsListener 

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

Listening endpoint for inbound WebSocket connections.

Holding this alive keeps the bound TCP socket open; dropping it closes the socket (the OS releases the port).

Implementations§

Source§

impl WsListener

Source

pub fn bind(scheme: &str, host: &str, port: u16) -> Result<Self>

Bind a new listener at host:port. The address family is always IPv4 (matching the loopback test pattern used by confium-net-tcp); pass 0.0.0.0 for any interface or 127.0.0.1 for loopback-only. Passing port 0 requests an ephemeral port from the OS; the caller can read the assigned port back via local_addr.

Source

pub fn local_addr(&self) -> Result<SocketAddr>

The locally-bound socket address. Useful for reading back the OS-assigned ephemeral port after binding with port 0.

Trait Implementations§

Source§

impl Drop for WsListener

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Listener for WsListener

Source§

fn accept(&mut self) -> Result<Box<dyn Transport>>

Block until a peer connects, then return the new transport.

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.