Struct CoreWebsocketClient 

pub struct CoreWebsocketClient { /* private fields */ }

Implements a websocket client.

To connect, use Ref<CoreWebsocketClient>::connect which will return an ActiveConnection which manages the lifecycle of the websocket connection.

Implementations

impl CoreWebsocketClient

pub fn notify_connected(&self) -> bool

Call the connect callback function, forward the callback returned value

pub fn notify_disconnected(&self)

Notify the callback function of a disconnect. This must be called at the end of an active websocket connection lifecycle, to free resources.

NOTE: This does not actually disconnect, use the Self::disconnect function for that.

pub fn notify_error(&self, msg: &str)

Call the error callback function, this is not a terminating request you must use CoreWebsocketClient::notify_disconnected to terminate the connection.

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

Call the read callback function, forward the callback returned value.

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

pub fn disconnect(&self) -> bool

Trait Implementations

impl ToOwned for CoreWebsocketClient

type Owned = Ref<CoreWebsocketClient>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Send for CoreWebsocketClient

impl Sync for CoreWebsocketClient