Skip to main content

ConnectionPool

Struct ConnectionPool 

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

Configurable pool for remote SDK connections.

Implementations§

Source§

impl ConnectionPool

Source

pub fn new( config: ConnectionPoolConfig, reconnect_config: ReconnectConfig, ) -> Result<Self, SdkError>

Creates a pool with exactly the caller-supplied connection count.

§Errors

Returns SdkError if the supplied configuration is invalid.

Source

pub const fn config(&self) -> ConnectionPoolConfig

Returns the caller-supplied pool configuration.

Source

pub const fn max_connections(&self) -> usize

Returns the caller-supplied maximum connection count.

Source

pub fn connection_count(&self) -> usize

Returns the number of managed connection slots.

Source

pub fn assign_subscription( &mut self, subscription_id: SubscriptionId, ) -> Result<SubscriptionAssignment, SdkError>

Assigns a subscription to the least-loaded pooled connection.

§Errors

Returns SdkError if the pool has no available connection entries.

Source

pub fn acknowledge( &mut self, subscription_id: SubscriptionId, sequence: u64, ) -> Result<(), SdkError>

Records an acknowledged sequence for the connection that owns a subscription.

§Errors

Returns SdkError when the subscription is not active in this pool.

Source

pub fn unsubscribe( &mut self, subscription_id: SubscriptionId, ) -> Result<(), SdkError>

Removes a subscription assignment and its recovery state.

§Errors

Returns SdkError when the subscription is not active in this pool.

Source

pub fn resume_requests_for_transition( &self, event: &ConnectionEvent, ) -> Result<Vec<ResumeRequest>, SdkError>

Builds subscription resume requests for every pooled connection on reconnect.

§Errors

Returns SdkError if any active subscription cannot compute a resume sequence.

Source

pub fn connection_for_subscription( &self, subscription_id: SubscriptionId, ) -> Option<PoolConnectionId>

Returns the connection assigned to a subscription, if it is active.

Source

pub fn subscription_count( &self, connection_id: PoolConnectionId, ) -> Result<usize, SdkError>

Returns the number of active subscriptions on a connection.

§Errors

Returns SdkError if the connection identifier is not part of this pool.

Source

pub fn recovery( &self, connection_id: PoolConnectionId, ) -> Result<&SubscriptionRecovery, SdkError>

Returns recovery state for a pooled connection.

§Errors

Returns SdkError if the connection identifier is not part of this pool.

Source

pub fn lifecycle( &self, connection_id: PoolConnectionId, ) -> Result<&ConnectionLifecycle, SdkError>

Returns lifecycle state for a pooled connection.

§Errors

Returns SdkError if the connection identifier is not part of this pool.

Trait Implementations§

Source§

impl Debug for ConnectionPool

Source§

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

Formats the value using the given formatter. 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