Struct WebSocket

pub struct WebSocket { /* private fields */ }

Implementations

impl WebSocket

pub fn new() -> Option<WebSocket>

Create a new WebSocket handler object. One object should be created by socket.

Examples

let mut ws = WebSocket::new().unwrap();
ws.connect("wss://echo.websocket.org/");

pub fn connect<T>(&mut self, url: T) -> bool

where T: AsRef<str>,

The connect method open a socket connection to the provided URL. This method should only be call if the current state of the handler is Closed, else the function will do nothing and return false.

Examples

let mut ws = WebSocket::new().unwrap();
ws.connect("wss://echo.websocket.org/");

pub fn get_id(&self) -> i32

Get id field of websocket.

pub fn get_state(&self) -> WebSocketState

Get current websocket state.

pub fn get_buffered_amount(&self) -> usize

Get the WebSocket.bufferedAmount field into bufferedAmount.

pub fn get_url(&self) -> String

Get the websocket URL field.

pub fn get_protocol(&self) -> String

Get the websocket protocol field.

pub fn clear_internal_callback(&mut self)

Clear all internal callbacks for current object.

pub fn set_open_callback(&mut self, cb: Option<fn(&mut Self)>)

Set on open callback for current object.

pub fn set_error_callback(&mut self, cb: Option<fn(&mut Self)>)

Set on error callback for current object.

pub fn set_close_callback(&mut self, cb: Option<fn(&mut Self)>)

Set on close callback for current object.

pub fn set_message_callback(&mut self, cb: Option<fn(&mut Self, WebSocketData)>)

Set on message callback for current object.

pub fn send_utf8_text<T>(&mut self, string: T) -> bool

where T: AsRef<str>,

Send UTF-8 formatted string through websocket. The state of current socket should be opened else the function will return false.

Examples

let mut ws = WebSocket::new().unwrap();
ws.connect("wss://echo.websocket.org/");
ws.send_utf8_text("foo");

pub fn send_binary(&mut self, data: &mut [u8]) -> bool

Send UTF-8 raw data through websocket. The state of current socket should be opened else the function will return false.

Examples

let mut ws = WebSocket::new().unwrap();
ws.connect("wss://echo.websocket.org/");
ws.send_binary([42, 69]);

pub fn close<T>(&mut self, code: u16, reason: T)

where T: AsRef<str>,

Close the current websocket. This function will clear all callbacks and trigger on close callback.

Examples

let mut ws = WebSocket::new().unwrap();
ws.connect("wss://echo.websocket.org/");
ws.close(1000, "over");

Trait Implementations

impl Drop for WebSocket

fn drop(&mut self)

Executes the destructor for this type.