Struct TunnelBuilder 

pub struct TunnelBuilder<R: Runtime> {
    builder: Arc<Builder<R, ClientTunnel>>,
    path_config: MutCfg<PathConfig>,
    storage: DynStorageHandle<ParetoTimeoutState>,
    guardmgr: GuardMgr<R>,
    vanguardmgr: Arc<VanguardMgr<R>>,
}

A factory object to build circuits.

A TunnelBuilder holds references to all the objects that are needed to build circuits correctly.

In general, you should not need to construct or use this object yourself, unless you are choosing your own paths.

Fields

builder: Arc<Builder<R, ClientTunnel>>

The underlying Builder object

path_config: MutCfg<PathConfig>

Configuration for how to choose paths for circuits.

storage: DynStorageHandle<ParetoTimeoutState>

State-manager object to use in storing current state.

guardmgr: GuardMgr<R>

Guard manager to tell us which guards nodes to use for the circuits we build.

vanguardmgr: Arc<VanguardMgr<R>>

The vanguard manager object used for HS circuits.

Implementations

impl<R: Runtime> TunnelBuilder<R>

pub(crate) fn new( runtime: R, chanmgr: Arc<ChanMgr<R>>, path_config: PathConfig, storage: DynStorageHandle<ParetoTimeoutState>, guardmgr: GuardMgr<R>, vanguardmgr: VanguardMgr<R>, ) -> Self

Construct a new TunnelBuilder.

pub(crate) fn path_config(&self) -> Arc<PathConfig>

Return this builder’s PathConfig.

pub(crate) fn set_path_config(&self, new_config: PathConfig)

Replace this builder’s PathConfig.

pub(crate) fn save_state(&self) -> Result<bool>

Flush state to the state manager if we own the lock.

Return Ok(true) if we saved, and Ok(false) if we didn’t hold the lock.

pub(crate) fn upgrade_to_owned_state(&self) -> Result<()>

Replace our state with a new owning state, assuming we have storage permission.

pub(crate) fn reload_state(&self) -> Result<()>

Reload persistent state from disk, if we don’t have storage permission.

pub fn update_network_parameters(&self, p: &NetParameters)

Reconfigure this builder using the latest set of network parameters.

(NOTE: for now, this only affects circuit timeout estimation.)

pub(crate) async fn build_owned( &self, path: OwnedPath, params: &CircParameters, guard_status: Arc<GuardStatusHandle>, usage: ChannelUsage, ) -> Result<ClientTunnel>

Like build, but construct a new circuit from an OwnedPath.

pub async fn build( &self, path: &TorPath<'_>, params: &CircParameters, usage: ChannelUsage, ) -> Result<ClientTunnel>

Try to construct a new circuit from a given path, using appropriate timeouts.

This circuit is not automatically registered with any circuit manager; if you don’t hang on it it, it will automatically go away when the last reference is dropped.

pub(crate) fn learning_timeouts(&self) -> bool

Return true if this builder is currently learning timeout info.

pub(crate) fn guardmgr(&self) -> &GuardMgr<R>

Return a reference to this builder’s GuardMgr.

pub(crate) fn vanguardmgr(&self) -> &Arc<VanguardMgr<R>>

Return a reference to this builder’s VanguardMgr.

pub(crate) fn runtime(&self) -> &R

Return a reference to this builder’s runtime

pub(crate) fn estimator(&self) -> &Estimator

Return a reference to this builder’s timeout estimator.

Trait Implementations

impl<R: Runtime> AbstractTunnelBuilder<R> for TunnelBuilder<R>

type Tunnel = ClientTunnel

The tunnel type that this builder knows how to build.

type Plan = Plan

An opaque type describing how a given tunnel will be built. It may represent some or all of a path-or it may not.

fn plan_tunnel( &self, usage: &TargetTunnelUsage, dir: DirInfo<'_>, ) -> Result<(Plan, SupportedTunnelUsage)>

Form a plan for how to build a new tunnel that supports usage.

fn build_tunnel<'life0, 'async_trait>( &'life0 self, plan: Plan, ) -> Pin<Box<dyn Future<Output = Result<(SupportedTunnelUsage, Self::Tunnel)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Construct a tunnel according to a given plan.

fn launch_parallelism(&self, spec: &TargetTunnelUsage) -> usize

Return a “parallelism factor” with which tunnels should be constructed for a given purpose.

fn select_parallelism(&self, spec: &TargetTunnelUsage) -> usize

Return a “parallelism factor” for which tunnels should be used for a given purpose.

fn learning_timeouts(&self) -> bool

Return true if we are currently attempting to learn tunnel timeouts by building testing tunnels.

fn save_state(&self) -> Result<bool>

Flush state to the state manager if we own the lock.

fn path_config(&self) -> Arc<PathConfig>

Return this builder’s PathConfig.

fn set_path_config(&self, new_config: PathConfig)

Replace this builder’s PathConfig.

fn estimator(&self) -> &Estimator

Return a reference to this builder’s timeout estimator.

fn vanguardmgr(&self) -> &Arc<VanguardMgr<R>>

Return a reference to this builder’s VanguardMgr.

fn upgrade_to_owned_state(&self) -> Result<()>

Replace our state with a new owning state, assuming we have storage permission.

fn reload_state(&self) -> Result<()>

Reload persistent state from disk, if we don’t have storage permission.

fn guardmgr(&self) -> &GuardMgr<R>

Return a reference to this builder’s GuardMgr.

fn update_network_parameters(&self, p: &NetParameters)

Reconfigure this builder using the latest set of network parameters.