Module build

Facilities to build circuits directly, instead of via a circuit manager.

Modules

guardstatus 🔒

Helpers for reporting information about guard status to the guard manager.

Structs

Builder 🔒

An implementation type for CircuitBuilder.

CircuitBuilder

A factory object to build circuits.

Traits

Buildable 🔒

Represents an objects that can be constructed in a circuit-like way.

Functions

build_cc_fixedwindow 🔒

Return the congestion control FixedWindow algorithm using the given network parameters.

build_cc_vegas 🔒 flowctl-cc

Return the congestion control Vegas algorithm using the given network parameters.

circparameters_from_netparameters 🔒

Return a new circuit parameter struct using the given network parameters and algorithm to use.

create_common 🔒

Try to make a [PendingClientCirc] to a given relay, and start its reactor.

double_timeout 🔒

Helper function: spawn a future as a background task, and run it with two separate timeouts.

exit_circparams_from_netparams

Extract a [CircParameters] from the [NetParameters] from a consensus for an exit circuit or single onion service (when implemented).

onion_circparams_from_netparams

Extract a [CircParameters] from the [NetParameters] from a consensus for an onion circuit which also includes an onion service with Vanguard.