Struct ConnPool 

pub struct ConnPool<C> { /* private fields */ }

Outbound connection pool.

The pool keeps an AutoEject tracker and a small idle list; callers acquire a connection through ConnPool::get and return it through ConnHandle::release (or by dropping the handle, which routes to the same path).

Implementations

impl<C: Send + 'static> ConnPool<C>

pub fn new(cfg: ConnPoolConfig) -> Self

Build a pool with no factory installed. Build a pool with no factory installed.

Callers must install a factory through ConnPool::set_factory before invoking ConnPool::get. The factory-less constructor exists so callers can build the pool eagerly during configuration and wire the factory once the resolver has populated the target address.

Examples

use dynomite::io::reactor::TcpTransport;
use dynomite::net::pool::{ConnPool, ConnPoolConfig};
let _: ConnPool<TcpTransport> = ConnPool::new(ConnPoolConfig::default());

pub fn with_factory<F>(cfg: ConnPoolConfig, factory: F) -> Self

where F: ConnFactory<C>,

Build a pool with a factory installed up front.

Examples

use dynomite::net::pool::{ConnPool, ConnPoolConfig};
use dynomite::net::NetError;
let pool = ConnPool::with_factory(ConnPoolConfig::default(), || async {
    Ok::<u32, NetError>(0)
});
assert_eq!(pool.config().max_connections, 1);

pub fn set_factory<F: ConnFactory<C>>(&mut self, factory: F)

Install a connection factory.

pub fn config(&self) -> ConnPoolConfig

Borrow the pool config.

pub fn idle_count(&self) -> usize

Number of idle connections currently in the pool.

pub fn in_flight(&self) -> usize

Number of in-flight (handed out) connections.

pub fn is_ejected(&self, now: Instant) -> bool

True when the host has been auto-ejected at this instant.

pub fn auto_eject(&self) -> AutoEject

Snapshot of the auto-eject tracker.

pub fn shutdown(&self)

Shut the pool down.

Wakes every waiter blocked in ConnPool::get. Subsequent get calls return NetError::PoolShutdown.

pub async fn get(&self) -> Result<ConnHandle<C>, NetError>

Acquire a connection.

Reuses an idle connection when one is available; otherwise invokes the factory until it succeeds or the auto-eject tracker reports the target as unreachable.

Errors

Returns NetError::Ejected when the host is in its eject window, NetError::PoolShutdown when the pool was shut down, or the underlying factory error otherwise.

Trait Implementations

impl<C> Clone for ConnPool<C>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for ConnPool<C>

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

Formats the value using the given formatter.