ReliableWebSocketSession

Struct ReliableWebSocketSession 

Source
pub struct ReliableWebSocketSession { /* private fields */ }
Expand description

Enhanced WebSocket session with reliability features

Implementations§

Source§

impl ReliableWebSocketSession

Source

pub fn new(url: String, config: WebSocketReliabilityConfig) -> Self

Create a new reliable WebSocket session

Source

pub async fn connect_reliable(&self) -> Result<()>

Connect with reliability features

§Errors

Returns an error if the WebSocket connection cannot be established after the maximum number of reconnection attempts, or if the connection times out.

§Panics

Panics if the internal mutex for tracking connection state is poisoned.

Source

pub async fn send_event_reliable( &self, event: RealtimeClientEvent, ) -> Result<()>

Send an event with reliability guarantees

§Errors

Returns an error if the event cannot be sent due to connection failures, serialization issues, or if the maximum reconnection attempts are exceeded.

§Panics

Panics if the internal mutex for message buffering is poisoned.

Source

pub async fn recv_event_reliable(&self) -> Result<RealtimeServerEvent>

Receive an event from the WebSocket

§Errors

Returns an error if no event can be received due to connection failures, WebSocket errors, or if no active connection exists.

Source

pub async fn get_connection_state(&self) -> ConnectionState

Get current connection state

Source

pub async fn is_connection_healthy(&self) -> bool

Check if connection is healthy

§Panics

Panics if the internal mutex for last heartbeat tracking is poisoned.

Source

pub async fn get_stats(&self) -> WebSocketConnectionStats

Get connection statistics

Source

pub fn get_buffered_message_count(&self) -> usize

Get buffered message count

§Panics

This function will panic if the message buffer mutex is poisoned.

Source

pub async fn flush_message_buffer(&self) -> Result<usize>

Flush message buffer and attempt to send all messages

§Errors

This function returns an error if the WebSocket session fails to send messages.

§Panics

This function will panic if the message buffer mutex is poisoned.

Source

pub async fn close(&self) -> Result<()>

Close the connection gracefully

§Errors

This function returns an error if the connection cannot be closed properly.

Trait Implementations§

Source§

impl Debug for ReliableWebSocketSession

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Drop for ReliableWebSocketSession

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<C, E> EntryToVal<C> for E
where C: Collection<Entry = E>,

Source§

type Val = <C as Collection>::Val

The type of values stored in the collection. This might be distinct from Entry in complex collections. For example, in a HashMap, while Entry might be a ( key, value ) tuple, Val might only be the value part.
Source§

fn entry_to_val(self) -> <E as EntryToVal<C>>::Val

Converts an entry into a value representation specific to the type of collection. This conversion is crucial for handling operations on entries, especially when they need to be treated or accessed as individual values, such as retrieving the value part from a key-value pair in a hash map.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoResult<T> for T

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<C, Val> ValToEntry<C> for Val
where C: CollectionValToEntry<Val>,

Source§

fn val_to_entry(self) -> <C as CollectionValToEntry<Val>>::Entry

Invokes the val_to_entry function of the CollectionValToEntry trait to convert the value to an entry.

Source§

type Entry = <C as CollectionValToEntry<Val>>::Entry

Represents the type of entry that corresponds to the value within the collection. Type Entry is defined by the Collection trait.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more