Skip to main content

ConnectionLifecycle

Struct ConnectionLifecycle 

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

Owns the SDK connection lifecycle state and emits validated transitions.

Implementations§

Source§

impl ConnectionLifecycle

Source

pub fn new(reconnect_config: ReconnectConfig) -> Self

Creates a lifecycle in the ConnectionState::Connecting state.

Source

pub const fn state(&self) -> &ConnectionState

Returns the current connection state.

Source

pub const fn reconnect_config(&self) -> ReconnectConfig

Returns the reconnect backoff configuration.

Source

pub fn observe( &mut self, observer: impl FnMut(&ConnectionEvent) + Send + 'static, )

Registers an observer that is called after each successful transition.

Source

pub fn connect(&mut self) -> Result<(), SdkError>

Transitions from ConnectionState::Disconnected to connecting.

§Errors

Returns SdkError when the lifecycle is not disconnected.

Source

pub fn connected(&mut self) -> Result<(), SdkError>

Transitions from connecting or reconnecting to connected.

§Errors

Returns SdkError when the lifecycle is disconnected or already connected.

Source

pub fn reconnect<J>(&mut self, jitter: &mut J) -> Result<Duration, SdkError>
where J: ReconnectJitter + ?Sized,

Transitions to reconnecting and returns the next retry delay.

The first reconnect attempt after a successful connection uses attempt zero. Each subsequent reconnect attempt increments the counter until a successful Self::connected transition resets it.

§Errors

Returns SdkError when reconnecting from the current state is invalid or when the jitter source exceeds the allowed jitter range.

Source

pub fn disconnect(&mut self, reason: DisconnectReason) -> Result<(), SdkError>

Transitions to disconnected with the supplied reason.

§Errors

Returns SdkError when the lifecycle is already disconnected.

Trait Implementations§

Source§

impl Debug for ConnectionLifecycle

Source§

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

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

impl Default for ConnectionLifecycle

Source§

fn default() -> Self

Returns the “default value” for a 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<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