Struct bililive_core::retry::RetryContext

pub struct RetryContext { /* fields omitted */ }

Internal context for server picking during (re)connection.

Implements a round-robin policy for server selection.

Implementations

impl RetryContext

pub const fn config(&self) -> &StreamConfig

Get the stream config.

pub fn get(&mut self) -> &str

Get the next server.

Trait Implementations

impl Clone for RetryContext

fn clone(&self) -> RetryContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetryContext

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

Formats the value using the given formatter.

impl From<StreamConfig> for RetryContext

fn from(config: StreamConfig) -> Self

Performs the conversion.

impl<T, E> UnderlyingStream<RetryContext, Result<Packet, StreamError<E>>, StreamError<E>> for WsStream<T, E> where
    T: WsStreamTrait<E>,
    E: Error, 

type Stream = T::Stream

fn establish(
    ctor_arg: RetryContext
) -> Pin<Box<dyn Future<Output = Result<Self::Stream, StreamError<E>>>>>

The creation function is used by ReconnectStream in order to establish both the initial IO connection in addition to performing reconnects.

fn is_write_disconnect_error(err: &StreamError<E>) -> bool

When sink send experience an Error during operation, it does not necessarily mean it is a disconnect/termination (ex: WouldBlock). You may specify which errors are considered “disconnects” by this method.

fn is_read_disconnect_error(item: &Result<Packet, StreamError<E>>) -> bool

It’s common practice for [Stream] implementations that return an Err when there’s an error. You may match the result to tell them apart from normal response. By default, no response is considered a “disconnect”.

fn exhaust_err() -> StreamError<E>

This is returned when retry quota exhausted.