Struct tor_circmgr::build::Builder

struct Builder<R: Runtime, C: Buildable + Sync + Send + 'static> {
    runtime: R,
    chanmgr: Arc<ChanMgr<R>>,
    timeouts: Estimator,
    _phantom: PhantomData<C>,
}

An implementation type for CircuitBuilder.

A CircuitBuilder 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

runtime: R

The runtime used by this circuit builder.

chanmgr: Arc<ChanMgr<R>>

A channel manager that this circuit builder uses to make channels.

timeouts: Estimator

An estimator to determine the correct timeouts for circuit building.

_phantom: PhantomData<C>

We don’t actually hold any clientcircs, so we need to put this type here so the compiler won’t freak out.

Implementations

impl<R: Runtime, C: Buildable + Sync + Send + 'static> Builder<R, C>

fn new(runtime: R, chanmgr: Arc<ChanMgr<R>>, timeouts: Estimator) -> Self

Construct a new Builder.

async fn build_notimeout( self: Arc<Self>, path: OwnedPath, params: CircParameters, start_time: Instant, n_hops_built: Arc<AtomicU32>, guard_status: Arc<GuardStatusHandle>, usage: ChannelUsage ) -> Result<Arc<C>>

Build a circuit, without performing any timeout operations.

After each hop is built, increments n_hops_built. Make sure that guard_status has its pending status set correctly to correspond to a circuit failure at any given stage.

(TODO: Find a better design there.)

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

Build a circuit from an OwnedPath.

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

Return a reference to this Builder runtime.

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

Return a reference to this Builder’s timeout estimator.