medea-jason 0.13.1

Client library for Medea media server.
Documentation
//! JS side handle for reconnections with a media server.

use derive_more::with_trait::From;
use js_sys::Promise;
use wasm_bindgen::prelude::*;
use wasm_bindgen_futures::future_to_promise;

use super::Error;
use crate::rpc;

/// Handle that JS side can reconnect to a media server with when a connection
/// is lost.
///
/// This handle is passed into a [`RoomHandle.on_connection_loss`] callback.
///
/// Like all the handles it contains a weak reference to the object that is
/// managed by Rust, so its methods will fail if a weak reference could not be
/// upgraded.
///
/// [`RoomHandle.on_connection_loss`]: crate::api::RoomHandle.on_connection_loss
#[wasm_bindgen]
#[derive(Clone, Debug, From)]
pub struct ReconnectHandle(rpc::ReconnectHandleImpl);

#[wasm_bindgen]
impl ReconnectHandle {
    /// Tries to reconnect after the provided delay in milliseconds.
    ///
    /// If [`RpcSession`] is already reconnecting then a new reconnection
    /// attempt won't be performed. Instead, it will wait for the first
    /// reconnection attempt result and use it.
    ///
    /// # Errors
    ///
    /// With a [`RpcClientException`] if reconnecting attempt fails.
    ///
    /// With a [`StateError`] if the underlying pointer has been freed.
    ///
    /// [`RpcClientException`]: crate::api::err::RpcClientException
    /// [`RpcSession`]: rpc::RpcSession
    /// [`StateError`]: crate::api::err::StateError
    pub fn reconnect_with_delay(&self, delay_ms: u32) -> Promise {
        let this = self.0.clone();
        future_to_promise(async move {
            this.reconnect_with_delay(delay_ms).await.map_err(Error::from)?;
            Ok(JsValue::UNDEFINED)
        })
    }

    /// Tries to reconnect a [`RpcSession`] in a loop with a growing backoff
    /// delay.
    ///
    /// The first attempt will be performed immediately, and the second attempt
    /// will be performed after `starting_delay_ms`.
    ///
    /// Delay between reconnection attempts won't be greater than
    /// `max_delay_ms`.
    ///
    /// After each reconnection attempt, delay between reconnections will be
    /// multiplied by the given `multiplier` until it reaches `max_delay_ms`.
    ///
    ///
    /// If `multiplier` is a negative number then it will be considered as
    /// `0.0`. This might cause a busy loop, so it's not recommended.
    ///
    /// Max elapsed time can be limited with an optional `max_elapsed_time_ms`
    /// argument.
    ///
    /// If [`RpcSession`] is already reconnecting then new reconnection attempt
    /// won't be performed. Instead, it will wait for the first reconnection
    /// attempt result and use it here.
    ///
    /// # Errors
    ///
    /// With a [`RpcClientException`] if reconnecting attempt fails.
    ///
    /// With a [`StateError`] if the underlying pointer has been freed.
    ///
    /// [`RpcClientException`]: crate::api::err::RpcClientException
    /// [`RpcSession`]: rpc::RpcSession
    /// [`StateError`]: crate::api::err::StateError
    pub fn reconnect_with_backoff(
        &self,
        starting_delay_ms: u32,
        multiplier: f32,
        max_delay: u32,
        max_elapsed_time_ms: Option<u32>,
    ) -> Promise {
        let this = self.0.clone();
        future_to_promise(async move {
            this.reconnect_with_backoff(
                starting_delay_ms,
                multiplier.into(),
                max_delay,
                max_elapsed_time_ms,
            )
            .await
            .map_err(Error::from)?;
            Ok(JsValue::UNDEFINED)
        })
    }
}