Struct WebSocket

pub struct WebSocket { /* private fields */ }

An async WebSocket implementation capable of operating uniformly under a browser-backed executor in WASM and under native tokio-runtime.

Implementations

impl WebSocket

pub fn new( url: Option<&str>, config: Option<WebSocketConfig>, ) -> Result<WebSocket>

Create a new WebSocket instance connecting to the given URL.

pub fn url(&self) -> Option<String>

Get current websocket connection URL

pub fn set_url(&self, url: &str)

Changes WebSocket connection URL. Following this call, you must invoke WebSocket::reconnect().await manually

pub fn configure(&self, config: WebSocketConfig)

Configure WebSocket connection settings Can be supplied after the WebSocket has been has been created to alter the configuration for the next connection.

pub fn sender_tx(&self) -> &Sender<(Message, Ack)>

Returns the reference to the Sender channel

pub fn receiver_rx(&self) -> &Receiver<Message>

Returns the reference to the Receiver channel

pub fn is_connected(&self) -> bool

Returns true if websocket is connected, false otherwise

pub async fn connect(&self, options: ConnectOptions) -> ConnectResult<Error>

Connects the websocket to the destination URL. Optionally accepts block_until_connected argument that will block the async execution until the websocket is connected.

Once invoked, connection task will run in the background and will attempt to repeatedly reconnect if the websocket connection is closed.

To suspend reconnection, you have to call disconnect() method explicitly.

pub async fn disconnect(&self) -> Result<()>

Disconnects the websocket from the destination server.

pub async fn reconnect(&self) -> Result<()>

Trigger WebSocket to reconnect. This method closes the underlying WebSocket connection causing the WebSocket implementation to re-initiate connection.

pub async fn post(&self, message: Message) -> Result<&Self>

Sends a message to the destination server. This function will queue the message on the relay channel and return successfully if the message has been queued. This function enforces async yield in order to prevent potential blockage of the executor if it is being executed in tight loops.

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

Sends a message to the destination server. This function will block until until the message was relayed to the underlying websocket implementation.

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

Receives message from the websocket. Blocks until a message is received from the underlying websocket connection.

pub fn trigger_abort(&self) -> Result<()>

Triggers a disconnection on the underlying WebSocket. This is intended for debug purposes only. Can be used to test application reconnection logic.

Trait Implementations

impl Clone for WebSocket

fn clone(&self) -> WebSocket

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.