pub struct ConnectionPool<PR = DefaultRemotingRequestProcessor> { /* private fields */ }Expand description
Advanced connection pool with lifecycle management.
§Configuration
ⓘ
use std::time::Duration;
use rocketmq_remoting::clients::connection_pool::ConnectionPool;
let pool = ConnectionPool::new(
1000, // max 1000 connections
Duration::from_secs(300), // idle timeout 5 minutes
);§Concurrency
- Read operations: Lock-free via DashMap
- Write operations: Fine-grained per-shard locking
- Scales: Linearly with CPU cores
§Memory
- Per connection: ~200 bytes overhead (metrics + metadata)
- Total: O(active_connections)
Implementations§
Source§impl<PR> ConnectionPool<PR>
impl<PR> ConnectionPool<PR>
Sourcepub fn new(max_connections: usize, max_idle_duration: Duration) -> Self
pub fn new(max_connections: usize, max_idle_duration: Duration) -> Self
Create a new connection pool with specified limits.
§Arguments
max_connections- Maximum number of connections (0 = unlimited)max_idle_duration- Idle timeout (e.g., 5 minutes)
§Example
ⓘ
use std::time::Duration;
use rocketmq_remoting::clients::connection_pool::ConnectionPool;
let pool = ConnectionPool::<()>::new(1000, Duration::from_secs(300));Sourcepub fn get(&self, addr: &CheetahString) -> Option<PooledConnection<PR>>where
PR: Clone,
pub fn get(&self, addr: &CheetahString) -> Option<PooledConnection<PR>>where
PR: Clone,
Get connection from pool or create new one.
§Returns
Some(conn)- Healthy connection from pool or newly createdNone- Failed to create connection or pool at capacity
Sourcepub fn insert(&self, addr: CheetahString, client: Client<PR>) -> bool
pub fn insert(&self, addr: CheetahString, client: Client<PR>) -> bool
Insert a new connection into the pool.
§Returns
true- Connection added successfullyfalse- Pool at capacity, connection rejected
Sourcepub fn remove(&self, addr: &CheetahString) -> Option<PooledConnection<PR>>
pub fn remove(&self, addr: &CheetahString) -> Option<PooledConnection<PR>>
Sourcepub fn get_metrics(
&self,
addr: &CheetahString,
) -> Option<Arc<ConnectionMetrics>>
pub fn get_metrics( &self, addr: &CheetahString, ) -> Option<Arc<ConnectionMetrics>>
Get connection metrics.
§Returns
Some(metrics)- Metrics for the connectionNone- Connection not in pool
Sourcepub fn record_success(&self, addr: &CheetahString, latency_ms: u64)
pub fn record_success(&self, addr: &CheetahString, latency_ms: u64)
Record successful request on connection.
Sourcepub fn record_error(&self, addr: &CheetahString)
pub fn record_error(&self, addr: &CheetahString)
Record failed request on connection.
Sourcepub async fn evict_idle(&self) -> usize
pub async fn evict_idle(&self) -> usize
Sourcepub async fn evict_unhealthy(&self) -> usize
pub async fn evict_unhealthy(&self) -> usize
Sourcepub fn start_cleanup_task(&self, interval: Duration) -> JoinHandle<()>
pub fn start_cleanup_task(&self, interval: Duration) -> JoinHandle<()>
Start background cleanup task.
Periodically evicts idle and unhealthy connections.
§Arguments
interval- Cleanup interval (e.g., 30 seconds)
§Returns
Task handle that can be awaited or aborted
§Example
ⓘ
let pool = ConnectionPool::<()>::new(1000, Duration::from_secs(300));
let cleanup_task = pool.start_cleanup_task(Duration::from_secs(30));
// ... use pool ...
cleanup_task.abort(); // Stop cleanup taskTrait Implementations§
Auto Trait Implementations§
impl<PR> Freeze for ConnectionPool<PR>
impl<PR = DefaultRemotingRequestProcessor> !RefUnwindSafe for ConnectionPool<PR>
impl<PR> Send for ConnectionPool<PR>
impl<PR> Sync for ConnectionPool<PR>
impl<PR> Unpin for ConnectionPool<PR>
impl<PR = DefaultRemotingRequestProcessor> !UnwindSafe for ConnectionPool<PR>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
Causes
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
Causes
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
Causes
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
Causes
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
Causes
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
Causes
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
Causes
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
Causes
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Pipes by value. This is generally the method you want to use. Read more
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
Borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
Mutably borrows
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
Borrows
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
Mutably borrows
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
Borrows
self, then passes self.deref() into the pipe function.Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Immutable access to the
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
Mutable access to the
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
Immutable access to the
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
Mutable access to the
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Immutable access to the
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Mutable access to the
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
Calls
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
Calls
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
Calls
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
Calls
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
Calls
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
Calls
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
Calls
.tap_deref() only in debug builds, and is erased in release
builds.