Struct ActiveConnectionCounter

pub struct ActiveConnectionCounter {
    count: usize,
    limit: usize,
    label: Arc<str>,
    close_notification_tx: UnboundedSender<ConnectionClosed>,
    close_notification_rx: UnboundedReceiver<ConnectionClosed>,
    connection_bar: Tx,
}

A counter for active connections.

Creates a ConnectionTracker to track each active connection. When these trackers are dropped, the counter gets notified.

Fields

count: usize

The number of active peers tracked using this counter.

limit: usize

The limit for this type of connection, for diagnostics only. The caller must enforce the limit by ignoring, delaying, or dropping connections.

label: Arc<str>

The label for this connection counter, typically its type.

close_notification_tx: UnboundedSender<ConnectionClosed>

The channel used to send closed connection notifications.

close_notification_rx: UnboundedReceiver<ConnectionClosed>

The channel used to receive closed connection notifications.

connection_bar: Tx

Active connection count progress transmitter.

Implementations

impl ActiveConnectionCounter

pub fn new_counter() -> Self

Create and return a new active connection counter.

pub fn new_counter_with<S: ToString>(limit: usize, label: S) -> Self

Create and return a new active connection counter with limit and label. The caller must check and enforce limits using update_count().

pub fn track_connection(&mut self) -> ConnectionTracker

Create and return a new ConnectionTracker, and add 1 to this counter.

When the returned tracker is dropped, this counter will be notified, and decreased by 1.

pub fn update_count(&mut self) -> usize

Check for closed connection notifications, and return the current connection count.

Trait Implementations

impl Debug for ActiveConnectionCounter

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

Formats the value using the given formatter.

impl Drop for ActiveConnectionCounter

fn drop(&mut self)

Executes the destructor for this type.