Struct WebSocketContext 

pub struct WebSocketContext { /* private fields */ }

A single WebSocket connection attempt, with its own read loop.

Implementations

impl WebSocketContext

pub fn new(end_point: SocketAddr, events: ConnectionEventSenders) -> Self

Creates a context for the given endpoint.

pub fn new_with_uri( end_point: SocketAddr, uri: String, events: ConnectionEventSenders, ) -> Self

Creates a context for the given endpoint and URI. The URI is passed in because it needs the host name, which end_point doesn’t have.

pub fn end_point(&self) -> SocketAddr

The endpoint this context is connected to.

pub fn uri(&self) -> &str

The websocket URI this context connects to.

pub fn is_cancelled(&self) -> bool

Whether the context has been cancelled.

pub fn cancel(&self)

Cancels the run loop.

pub fn notify_disconnected(&self, user_initiated: bool)

Raises the Disconnected event exactly once.

pub fn start(self: Arc<Self>, socket: Arc<dyn WebSocketSocket>)

Starts the read loop.

Trait Implementations

impl Debug for WebSocketContext

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

Formats the value using the given formatter.