Skip to main content

PeerConnectionPool

Struct PeerConnectionPool 

Source
pub struct PeerConnectionPool {
    pub connections: HashMap<u64, PeerPooledConnection>,
    pub next_conn_id: u64,
    pub config: PeerPoolConfig,
    pub total_acquired: u64,
    pub total_released: u64,
    pub total_evicted: u64,
}
Expand description

Tick-based, single-threaded peer connection pool.

Manages a set of reusable PeerPooledConnections keyed by a monotonically increasing conn_id. Callers drive time by passing an explicit tick counter; the pool does not use wall-clock time.

§Example

use ipfrs_network::connection_pool::{PeerConnectionPool, PeerPoolConfig};

let mut pool = PeerConnectionPool::new(PeerPoolConfig::default());
let tick = 0_u64;

// Acquire (or create) a connection for "peer-1".
let conn_id = pool.acquire("peer-1", tick).expect("should succeed");

// Return the connection to the idle pool.
assert!(pool.release(conn_id, tick + 1));

// Evict connections that have been idle for too long.
pool.evict_idle(tick + 100);

Fields§

§connections: HashMap<u64, PeerPooledConnection>

All connections, keyed by their unique conn_id.

§next_conn_id: u64

Monotonically increasing counter for assigning connection IDs.

§config: PeerPoolConfig

Pool configuration.

§total_acquired: u64

Cumulative successful acquires.

§total_released: u64

Cumulative successful releases.

§total_evicted: u64

Cumulative evictions.

Implementations§

Source§

impl PeerConnectionPool

Source

pub fn new(config: PeerPoolConfig) -> Self

Create a new, empty pool with the given configuration.

Source

pub fn acquire(&mut self, peer_id: &str, tick: u64) -> Option<u64>

Acquire a connection for peer_id at the given logical tick.

Returns Some(conn_id) on success:

  • If an Idle connection exists for the peer it is reused (set to InUse).
  • Otherwise a new connection is created if the per-peer and global caps allow it.

Returns None when all capacity limits are exhausted.

Source

pub fn release(&mut self, conn_id: u64, tick: u64) -> bool

Return a connection to the idle pool.

Returns true on success, false if the connection was not found or was not in the InUse state.

Source

pub fn close(&mut self, conn_id: u64) -> bool

Mark a connection as Closing.

Returns false if no connection with the given ID exists.

Source

pub fn evict_idle(&mut self, tick: u64)

Evict connections that are stale or marked for teardown.

Removes:

  • Idle connections whose last_used_tick is at least idle_timeout_ticks ticks in the past.
  • All Closing connections.

total_evicted is incremented for each removed connection.

Source

pub fn connections_for_peer<'a>( &'a self, peer_id: &str, ) -> Vec<&'a PeerPooledConnection>

Return all connections associated with peer_id, sorted ascending by conn_id.

Source

pub fn stats(&self) -> PeerPoolStats

Return a point-in-time snapshot of pool statistics.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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