Struct RealtimeClient 

pub struct RealtimeClient { /* private fields */ }

Implementations

impl RealtimeClient

pub fn new(config: RealtimeClientConfig) -> Self

pub async fn connect(&mut self) -> Result<Receiver<Event>, AuraxisError>

Send a message to the websocket connection.

This function will be spawned as a task and will run concurrently to the rest of the application. It will continually check for messages on the receiver end of the channel. When a message is received, it will be sent to the websocket connection. If sending the message fails, the error is logged and the connection is closed.

Arguments

• websocket - The websocket connection to send messages to.
• receiver - The channel receiving messages to send.

Errors

This function will return an error if the websocket connection cannot be created.

pub fn subscribe(&mut self, subscription: SubscriptionSettings)

pub fn clear_subscribe(&mut self, subscription: SubscriptionSettings)

pub fn clear_all_subscriptions(&mut self)

Trait Implementations

impl Clone for RealtimeClient

fn clone(&self) -> RealtimeClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RealtimeClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.