Struct WebSockets 

pub struct WebSockets<'a, WE> {
    pub socket: Option<(WebSocketStream<MaybeTlsStream<TcpStream>>, Response)>,
    /* private fields */
}

Fields

socket: Option<(WebSocketStream<MaybeTlsStream<TcpStream>>, Response)>

Implementations

impl<'a, WE: DeserializeOwned> WebSockets<'a, WE>

pub fn new<Callback>(handler: Callback) -> WebSockets<'a, WE>

where Callback: FnMut(WE) -> Result<()> + 'a + Send,

New websocket holder with default configuration

Examples

see examples/binance_websockets.rs

pub fn new_with_options<Callback>( handler: Callback, conf: Config, ) -> WebSockets<'a, WE>

where Callback: FnMut(WE) -> Result<()> + 'a + Send,

New websocket holder with provided configuration

Examples

see examples/binance_websockets.rs

pub async fn connect_multiple(&mut self, endpoints: Vec<String>) -> Result<()>

Connect to multiple websocket endpoints N.B: WE has to be CombinedStreamEvent

pub async fn connect(&mut self, endpoint: &str) -> Result<()>

Connect to a websocket endpoint

pub async fn connect_futures(&mut self, endpoint: &str) -> Result<()>

Connect to a futures websocket endpoint

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

Disconnect from the endpoint

pub fn socket( &self, ) -> &Option<(WebSocketStream<MaybeTlsStream<TcpStream>>, Response)>

pub async fn event_loop(&mut self, running: &AtomicBool) -> Result<()>