Struct yew_hooks::prelude::UseWebSocketOptions

pub struct UseWebSocketOptions {
    pub onopen: Option<Box<dyn FnMut(Event)>>,
    pub onmessage: Option<Box<dyn FnMut(String)>>,
    pub onmessage_bytes: Option<Box<dyn FnMut(Vec<u8>)>>,
    pub onerror: Option<Box<dyn FnMut(Event)>>,
    pub onclose: Option<Box<dyn FnMut(CloseEvent)>>,
    pub reconnect_limit: Option<u32>,
    pub reconnect_interval: Option<u32>,
    pub manual: Option<bool>,
    pub protocols: Option<Vec<String>>,
}

Options for WebSocket.

Fields

onopen: Option<Box<dyn FnMut(Event)>>

WebSocket connect callback.

onmessage: Option<Box<dyn FnMut(String)>>

WebSocket message callback for text.

onmessage_bytes: Option<Box<dyn FnMut(Vec<u8>)>>

WebSocket message callback for binary.

onerror: Option<Box<dyn FnMut(Event)>>

WebSocket error callback.

onclose: Option<Box<dyn FnMut(CloseEvent)>>

WebSocket close callback.

reconnect_limit: Option<u32>

Retry times. Defaults to 3, use u32::MAX for infinite retries.

reconnect_interval: Option<u32>

Retry interval(ms). Defaults to 3000.

manual: Option<bool>

Manually starts connection

protocols: Option<Vec<String>>

Sub protocols

Trait Implementations

impl Default for UseWebSocketOptions

fn default() -> UseWebSocketOptions

Returns the “default value” for a type.