Struct MultiplexPool 

pub struct MultiplexPool<C, ID> { /* private fields */ }

Available on crate feature std only.

Connection pool that multiplexes concurrent users over shared connections.

Implementations

impl<C, ID> MultiplexPool<C, ID>

pub fn new( max_concurrent_streams: NonZeroUsize, max_total: NonZeroUsize, ) -> Self

Create a new MultiplexPool from validated, non-zero limits.

pub fn try_new( max_concurrent_streams: usize, max_total: usize, ) -> Result<Self, BoxError>

Create a new MultiplexPool.

• max_concurrent_streams: upper bound on the concurrent users a single connection serves. The actual per-connection concurrency is the minimum of this and the connection’s MaxConcurrency extension (usize::MAX if unset), so use usize::MAX to defer entirely to what each connection advertises.
• max_total: max number of connections (across all ids).

pub fn maybe_with_idle_timeout(self, timeout: Option<Duration>) -> Self

Drop connections that have been idle (no active streams) for longer than the given timeout. Only checked when a connection is requested.

pub fn maybe_set_idle_timeout(&mut self, timeout: Option<Duration>) -> &mut Self

Drop connections that have been idle (no active streams) for longer than the given timeout. Only checked when a connection is requested.

pub fn with_idle_timeout(self, timeout: Duration) -> Self

Drop connections that have been idle (no active streams) for longer than the given timeout. Only checked when a connection is requested.

pub fn set_idle_timeout(&mut self, timeout: Duration) -> &mut Self

Drop connections that have been idle (no active streams) for longer than the given timeout. Only checked when a connection is requested.

pub fn without_idle_timeout(self) -> Self

Drop connections that have been idle (no active streams) for longer than the given timeout. Only checked when a connection is requested.

pub fn unset_idle_timeout(&mut self) -> &mut Self

Drop connections that have been idle (no active streams) for longer than the given timeout. Only checked when a connection is requested.

pub fn with_selection(self, selection: MuxSelection) -> Self

Set the MuxSelection strategy used to pick among same-id connections.

pub fn set_selection(&mut self, selection: MuxSelection) -> &mut Self

Set the MuxSelection strategy used to pick among same-id connections.

pub fn maybe_with_metrics(self, metrics: Option<Arc<PoolMetrics>>) -> Self

Available on crate feature opentelemetry only.

pub fn maybe_set_metrics( &mut self, metrics: Option<Arc<PoolMetrics>>, ) -> &mut Self

Available on crate feature opentelemetry only.

pub fn with_metrics(self, metrics: Arc<PoolMetrics>) -> Self

Available on crate feature opentelemetry only.

pub fn set_metrics(&mut self, metrics: Arc<PoolMetrics>) -> &mut Self

Available on crate feature opentelemetry only.

pub fn without_metrics(self) -> Self

Available on crate feature opentelemetry only.

pub fn unset_metrics(&mut self) -> &mut Self

Available on crate feature opentelemetry only.

Trait Implementations

impl<C, ID> Clone for MultiplexPool<C, ID>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C, ID> Debug for MultiplexPool<C, ID>

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

Formats the value using the given formatter.

impl<C, ID> Extension for MultiplexPool<C, ID>

where C: Send + Sync + 'static, ID: Send + Sync + Debug + 'static,

impl<C, ID> NetExtension for MultiplexPool<C, ID>

where C: Send + Sync + 'static, ID: Send + Sync + Debug + 'static,

impl<C, ID> Pool<C, ID> for MultiplexPool<C, ID>

where C: Send + Sync + ExtensionsRef + 'static, ID: ConnID,

type Connection = MultiplexedConnection<C, ID>

type CreatePermit = PoolSlot

async fn get_conn( &self, id: &ID, ) -> Result<ConnectionResult<Self::Connection, Self::CreatePermit>, BoxError>

Get a connection from the pool, if no connection is found a Pool::CreatePermit is returned

async fn create(&self, id: ID, conn: C, pool_slot: PoolSlot) -> Self::Connection

Create/add a new connection to the pool