Module mgr 

Abstract code to manage a set of tunnels which has underlying circuit(s).

This module implements the real logic for deciding when and how to launch tunnels, and for which tunnels to hand out in response to which requests.

For testing and abstraction purposes, this module does not actually know anything about tunnels per se. Instead, everything is handled using a set of traits that are internal to this crate:

• AbstractTunnel is a view of a tunnel.
• AbstractTunnelBuilder knows how to build an AbstractCirc.

Using these traits, the AbstractTunnelMgr object manages a set of tunnels , launching them as necessary, and keeping track of the restrictions on their use.

Modules

streams 🔒

Stream utilities to help implement AbstractCircMgr

Structs

AbstractTunnelMgr 🔒

Abstract implementation for tunnel management.

ExpirationParameters 🔒

Settings to determine when circuits are expired.

OpenEntry 🔒

An entry for an open tunnel held by an AbstractTunnelMgr.

PendingEntry 🔒

An entry for an under-construction in-progress tunnel tracked by an AbstractTunnelMgr.

PendingRequest 🔒

An in-progress tunnel request tracked by an AbstractTunnelMgr.

TunnelBuildPlan 🔒

Wrapper type to represent the state between planning to build a tunnel and constructing it.

TunnelList 🔒

The inner state of an AbstractTunnelMgr.

UnusedTimings 🔒

Timing information for tunnels that have been built but never used.

Enums

Action 🔒

An action to take in order to satisfy a request for a tunnel.

ExpirationInfo 🔒

Enumeration to track the expiration state of a tunnel.

RestrictionFailed

An error returned when we cannot apply circuit restriction.

ShouldExpire 🔒

When should a tunnel expire?

TunnelProvenance 🔒

Description of how we got a tunnel.

Traits

AbstractTunnel 🔒

Minimal abstract view of a tunnel.

AbstractTunnelBuilder 🔒

An object that knows how to build tunnels.

MockablePlan 🔒

A plan for an AbstractCircBuilder that can maybe be mutated by tests.

Functions

spawn_expiration_task 🔒

Spawn an expiration task that expires a tunnel at given instant.

Type Aliases

PendResult 🔒

A result type whose “Ok” value is the Id for a tunnel from B.

PtrWeakHashSet 🔒

Alias to force use of RandomState, regardless of features enabled in weak_tables.