Struct WebSocketConnection 

pub struct WebSocketConnection { /* private fields */ }

A Steam WebSocket connection.

Implementations

impl WebSocketConnection

pub fn new(factory: Arc<dyn WebSocketFactory>) -> Self

Creates a websocket connection that uses the given factory to open sockets.

pub fn new_tungstenite() -> Self

Creates a websocket connection that opens tokio-tungstenite sockets.

pub fn new_tungstenite_for_host(host: impl Into<String>) -> Self

Opens tokio-tungstenite sockets to the given host name. The host name is kept because it’s the TLS server name.

pub fn new_tungstenite_for_host_with_user_agent( host: impl Into<String>, user_agent: impl Into<String>, ) -> Self

Like new_tungstenite_for_host, and also sends the given User-Agent with the upgrade request.

pub fn subscribe_net_msg_received(&self) -> Receiver<NetMsgEventArgs>

Subscribes to the NetMsgReceived event.

pub fn subscribe_connected(&self) -> Receiver<()>

Subscribes to the Connected event.

pub fn subscribe_disconnected(&self) -> Receiver<DisconnectedEventArgs>

Subscribes to the Disconnected event.

Trait Implementations

impl ConnectionEvents for WebSocketConnection

fn events(&self) -> UnboundedReceiver<ConnectionEvent>

Subscribes to all three events as one stream.

fn net_msg_received(&self) -> Receiver<NetMsgEventArgs>

Subscribes to the NetMsgReceived event.

fn connected(&self) -> Receiver<()>

Subscribes to the Connected event.

fn disconnected(&self) -> Receiver<DisconnectedEventArgs>

Subscribes to the Disconnected event.

impl Debug for WebSocketConnection

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

Formats the value using the given formatter.

impl IConnection for WebSocketConnection

fn current_end_point(&self) -> Option<SocketAddr>

The remote endpoint of the current connection.

fn protocol_types(&self) -> ProtocolTypes

The type of communication protocol that this connection uses.

fn connect<'life0, 'async_trait>( &'life0 self, end_point: SocketAddr, timeout: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), SteamError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Connects to the specified endpoint.

fn disconnect<'life0, 'async_trait>( &'life0 self, user_initiated: bool, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Disconnects. user_initiated is true when the caller asked for it.

fn send<'life0, 'async_trait>( &'life0 self, data: Bytes, ) -> Pin<Box<dyn Future<Output = Result<(), SteamError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sends the specified data packet.

fn local_ip(&self) -> Option<IpAddr>

The local IP of the underlying socket, when one is bound.