Struct DeadpoolConnectionProvider 

pub struct DeadpoolConnectionProvider {
    pub health_check_metrics: Arc<HealthCheckMetrics>,
    /* private fields */
}

Connection provider using deadpool for connection pooling

Fields

health_check_metrics: Arc<HealthCheckMetrics>

Metrics for health check operations (lock-free)

Implementations

impl DeadpoolConnectionProvider

pub fn builder(host: impl Into<String>, port: u16) -> Builder

Create a builder for constructing a connection provider

Examples

use nntp_proxy::pool::DeadpoolConnectionProvider;

let provider = DeadpoolConnectionProvider::builder("news.example.com", 119)
    .name("Example")
    .max_connections(15)
    .build()
    .unwrap();

pub fn simple(host: impl Into<String>, port: u16) -> Result<Self>

Create a simple connection provider with defaults

Useful for testing and simple use cases. Uses 10 connections, no auth.

Examples

use nntp_proxy::pool::DeadpoolConnectionProvider;

let provider = DeadpoolConnectionProvider::simple("news.example.com", 119)?;

Errors

Returns any validation or pool-construction error from the builder.

pub fn with_auth( host: impl Into<String>, port: u16, username: impl Into<String>, password: impl Into<String>, ) -> Result<Self>

Create a connection provider with authentication

Convenience constructor for the common case of username/password auth.

Examples

use nntp_proxy::pool::DeadpoolConnectionProvider;

let provider = DeadpoolConnectionProvider::with_auth(
    "news.example.com",
    119,
    "myuser",
    "mypass",
)?;

Errors

Returns any validation or pool-construction error from the builder.

pub fn with_tls(host: impl Into<String>, port: u16) -> Result<Self>

Create a TLS-enabled connection provider

Uses default TLS settings (verify certificates, system CA store). For NNTPS (port 563) or STARTTLS.

Examples

use nntp_proxy::pool::DeadpoolConnectionProvider;

let provider = DeadpoolConnectionProvider::with_tls("news.example.com", 563)?;

Errors

Returns any TLS initialization, validation, or pool-construction error.

pub fn with_tls_auth( host: impl Into<String>, port: u16, username: impl Into<String>, password: impl Into<String>, ) -> Result<Self>

Create a TLS-enabled connection provider with authentication

Combines TLS with username/password auth - the most common setup for commercial Usenet providers.

Examples

use nntp_proxy::pool::DeadpoolConnectionProvider;

let provider = DeadpoolConnectionProvider::with_tls_auth(
    "news.example.com",
    563,
    "myuser",
    "mypass",
)?;

Errors

Returns any TLS initialization, validation, or pool-construction error.

pub fn new( host: String, port: u16, name: String, max_size: usize, username: Option<String>, password: Option<String>, ) -> Self

Create a new connection provider (plain TCP, no TLS)

For TLS support, use new_with_tls() or the builder API.

Panics

Panics only if plain TcpManager construction unexpectedly becomes fallible or deadpool rejects the requested pool size.

pub fn new_with_tls( host: String, port: u16, name: String, max_size: usize, username: Option<String>, password: Option<String>, tls_config: TlsConfig, ) -> Result<Self>

Create a new connection provider with TLS support

Errors

Returns any TLS initialization or provider-construction error.

pub fn from_server_config( server: &Server, recv_buffer_size: usize, send_buffer_size: usize, ) -> Result<Self>

Create a connection provider from a server configuration

This avoids unnecessary cloning of individual fields.

Errors

Returns any TLS initialization or manager-construction error implied by the server configuration.

Panics

Panics only if deadpool rejects the validated pool size.

pub async fn get_pooled_connection( &self, ) -> Result<Object<TcpManager>, ConnectionError>

Get a connection from the pool (automatically returned when dropped)

Errors

Returns crate::connection_error::ConnectionError if deadpool cannot provide a healthy backend connection.

pub fn clear_idle_connections(&self)

Clear all idle connections from the pool

This drops all idle connections by resizing the pool to 0 and back. Active (checked-out) connections are not affected - they will be discarded when returned instead of being recycled.

Use this to clear potentially stale connections after an idle period.

pub fn remove_without_cooldown(&self, conn: Object<TcpManager>)

Remove a connection without temporarily reducing pool size.

Use this when the connection cannot be safely returned to the pool, but the backend did not fail. For example, a client disconnect can leave unread backend response bytes in flight, making the socket dirty without implying that replacement connections should be throttled.

pub fn remove_with_cooldown(&self, conn: Object<TcpManager>)

Remove a broken connection and temporarily reduce pool size.

Gives the backend time to release the old connection’s slot before deadpool creates a replacement. Prevents connection count from exceeding the backend’s limit during high churn.

If replacement_cooldown is None or Duration::ZERO (disabled), immediately drops the connection without cooldown (behaves like normal pool removal).

CRITICAL: When cooldown is active, we resize the pool BEFORE dropping the connection. Otherwise, between drop(conn) and pool.resize(), any waiter calling pool.get() sees size < max_size and immediately creates a replacement — defeating the cooldown entirely.

The ordering invariant is enforced at compile time: conn is moved into either [shutdown_and_drop] or [resize_then_drop], so the caller cannot accidentally drop(conn) before pool.resize(). Any attempt to reorder would be a use-after-move error.

pub fn max_size(&self) -> usize

Get the maximum pool size

pub fn name(&self) -> &str

Get the name/identifier of this connection pool

pub fn status_counts(&self) -> DeadpoolStatusCounts

pub fn host(&self) -> &str

Get the backend host this pool connects to

pub fn port(&self) -> u16

Get the backend port this pool connects to

pub fn health_check_metrics(&self) -> &HealthCheckMetrics

Get a reference to the health check metrics

pub fn shutdown(&self)

Gracefully shutdown the periodic health check task

This sends a shutdown signal to the background health check task. The task will complete its current cycle and then terminate.

pub async fn graceful_shutdown(&self)

Gracefully shutdown the pool

Trait Implementations

impl Clone for DeadpoolConnectionProvider

fn clone(&self) -> DeadpoolConnectionProvider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConnectionProvider for DeadpoolConnectionProvider

fn status(&self) -> PoolStatus

Get current pool status for monitoring

impl Debug for DeadpoolConnectionProvider

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

Formats the value using the given formatter.