Struct UseWebSocketOptions

pub struct UseWebSocketOptions<Rx, E, D, Hb, HbCodec>
where
    Rx: ?Sized,
    Hb: Default + Send + Sync + 'static,
    HbCodec: Encoder<Hb> + HybridEncoder<Hb, <HbCodec as Encoder<Hb>>::Encoded, Error = <HbCodec as Encoder<Hb>>::Error>,
{ /* private fields */ }

Options for use_websocket_with_options.

Implementations

impl<Rx, E, D, Hb, HbCodec> UseWebSocketOptions<Rx, E, D, Hb, HbCodec>

where Rx: ?Sized, Hb: Default + Send + Sync + 'static, HbCodec: Encoder<Hb> + HybridEncoder<Hb, <HbCodec as Encoder<Hb>>::Encoded, Error = <HbCodec as Encoder<Hb>>::Error>,

pub fn on_open(self, value: impl Fn(Event) + Send + Sync + 'static) -> Self

WebSocket connect callback.

pub fn on_message_raw( self, value: impl Fn(&str) + Send + Sync + 'static, ) -> Self

WebSocket message callback for text.

pub fn on_message_raw_bytes( self, value: Arc<dyn Fn(&[u8]) + Send + Sync>, ) -> Self

WebSocket message callback for binary.

pub fn on_close( self, value: impl Fn(CloseEvent) + Send + Sync + 'static, ) -> Self

WebSocket close callback.

pub fn reconnect_limit(self, value: ReconnectLimit) -> Self

Retry times. Defaults to ReconnectLimit::Limited(3). Use ReconnectLimit::Infinite for infinite retries.

pub fn reconnect_interval(self, value: u64) -> Self

Retry interval in ms. Defaults to 3000.

pub fn immediate(self, value: bool) -> Self

If true the WebSocket connection will immediately be opened when calling this function. If false you have to manually call the open function. Defaults to true.

pub fn protocols(self, value: impl Into<Signal<Option<Vec<String>>>>) -> Self

Sub protocols. See MDN Docs.

Can be set as a signal to support protocols only available after the initial render.

Note that protocols are only updated on the next websocket open() call, not whenever the signal is updated. Therefore “lazy” protocols should use the immediate(false) option and manually call open().

impl<Rx: ?Sized, E, D, Hb, HbCodec> UseWebSocketOptions<Rx, E, D, Hb, HbCodec>

where Hb: Default + Send + Sync + 'static, HbCodec: Encoder<Hb> + HybridEncoder<Hb, <HbCodec as Encoder<Hb>>::Encoded, Error = <HbCodec as Encoder<Hb>>::Error>,

pub fn on_error<F>(self, handler: F) -> Self

where F: Fn(UseWebSocketError<E, D>) + Send + Sync + 'static,

WebSocket error callback.

pub fn on_message<F>(self, handler: F) -> Self

where F: Fn(&Rx) + Send + Sync + 'static,

WebSocket message callback for typed message decoded by codec.

pub fn heartbeat<NewHb, NewHbCodec>( self, interval: u64, ) -> UseWebSocketOptions<Rx, E, D, NewHb, NewHbCodec>

where NewHb: Default + Send + Sync + 'static, NewHbCodec: Encoder<NewHb> + HybridEncoder<NewHb, <NewHbCodec as Encoder<NewHb>>::Encoded, Error = <NewHbCodec as Encoder<NewHb>>::Error>,

Set the data, codec and interval at which the heartbeat is sent. The heartbeat is the default value of the NewHb type.

Trait Implementations

impl<Rx: ?Sized, E, D> Default for UseWebSocketOptions<Rx, E, D, (), DummyEncoder>

fn default() -> Self

Returns the “default value” for a type.