Struct HsCircPoolInner

pub(crate) struct HsCircPoolInner<B: AbstractCircBuilder<R> + 'static, R: Runtime> {
    circmgr: Arc<CircMgrInner<B, R>>,
    launcher_handle: OnceCell<TaskHandle>,
    inner: Mutex<Inner<B::Circ>>,
}

Available on crate feature hs-common only.

An object to provide circuits for implementing onion services.

Fields

circmgr: Arc<CircMgrInner<B, R>>

An underlying circuit manager, used for constructing circuits.

launcher_handle: OnceCell<TaskHandle>

A task handle for making the background circuit launcher fire early.

inner: Mutex<Inner<B::Circ>>

The mutable state of this pool.

Implementations

impl<R: Runtime> HsCircPoolInner<CircuitBuilder<R>, R>

pub(crate) fn new(circmgr: &CircMgr<R>) -> Self

Internal implementation for HsCircPool::new.

impl<B: AbstractCircBuilder<R> + 'static, R: Runtime> HsCircPoolInner<B, R>

pub(crate) fn new_internal(circmgr: &Arc<CircMgrInner<B, R>>) -> Self

Create a new HsCircPoolInner from a CircMgrInner.

pub(crate) fn launch_background_tasks( self: &Arc<Self>, runtime: &R, netdir_provider: &Arc<dyn NetDirProvider + 'static>, ) -> Result<Vec<TaskHandle>>

Internal implementation for HsCircPool::launch_background_tasks.

pub(crate) async fn get_or_launch_client_rend<'a>( &self, netdir: &'a NetDir, ) -> Result<(Arc<B::Circ>, Relay<'a>)>

Internal implementation for HsCircPool::get_or_launch_client_rend.

pub(crate) async fn get_or_launch_specific<T>( &self, netdir: &NetDir, kind: HsCircKind, target: T, ) -> Result<Arc<B::Circ>>

where T: CircTarget + Sync,

Internal implementation for HsCircPool::get_or_launch_specific.

async fn extend_circ<T>( &self, circ: HsCircStem<B::Circ>, params: CircParameters, target: T, ) -> Result<Arc<B::Circ>>

where T: CircTarget + Sync,

Try to extend a circuit to the specified target hop.

pub(crate) fn retire_all_circuits(&self) -> StdResult<(), ReconfigureError>

Internal implementation for HsCircPool::retire_all_circuits.

async fn take_or_launch_stem_circuit<T>( &self, netdir: &NetDir, avoid_target: Option<&T>, kind: HsCircKind, ) -> Result<HsCircStem<B::Circ>>

where T: CircTarget + Sync,

Take and return a circuit from our pool suitable for being extended to avoid_target.

If vanguards are enabled, this will try to build a circuit stem appropriate for use as the specified kind.

If vanguards are disabled, kind is unused.

If there is no such circuit, build and return a new one.

async fn maybe_extend_stem_circuit<T>( &self, netdir: &NetDir, circuit: HsCircStem<B::Circ>, avoid_target: Option<&T>, stem_kind: HsCircStemKind, circ_kind: HsCircKind, ) -> Result<HsCircStem<B::Circ>>

where T: CircTarget + Sync,

Return a circuit of the specified kind, built from circuit.

async fn extend_full_vanguards_circuit<T>( &self, netdir: &NetDir, circuit: HsCircStem<B::Circ>, avoid_target: Option<&T>, stem_kind: HsCircStemKind, circ_kind: HsCircKind, ) -> Result<HsCircStem<B::Circ>>

where T: CircTarget + Sync,

Available on crate feature vanguards only.

Extend the specified full vanguard circuit if necessary.

fn ensure_suitable_circuit<T>( &self, circ: &Arc<B::Circ>, target: Option<&T>, kind: HsCircStemKind, ) -> Result<()>

where T: CircTarget + Sync,

Ensure circ is compatible with target, and has the correct length for its kind.

fn ensure_circuit_length_valid( &self, circ: &Arc<B::Circ>, kind: HsCircStemKind, ) -> Result<()>

Ensure the specified circuit of type kind has the right length.

fn ensure_circuit_can_extend_to_target<T>( circ: &Arc<B::Circ>, target: Option<&T>, ) -> Result<()>

where T: CircTarget + Sync,

Ensure that it is possible to extend circ to target.

Returns an error if either of the last 2 hops of the circuit are the same as target, because:

• a relay won’t let you extend the circuit to itself
• relays won’t let you extend the circuit to their previous hop

fn remove_closed(&self)

Internal: Remove every closed circuit from this pool.

fn remove_unlisted(&self, netdir: &NetDir)

Internal: Remove every circuit form this pool for which any relay is not listed in netdir.

fn vanguard_mode(&self) -> VanguardMode

Returns the current [VanguardMode].

pub(crate) fn estimate_timeout(&self, timeout_action: &Action) -> Duration

Internal implementation for HsCircPool::estimate_timeout.