Skip to main content

Module build

Module build 

Source
Expand description

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 TunnelBuilder.
TunnelBuilder
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_fixedwindow_params ๐Ÿ”’
Return the parameters for the congestion control FixedWindow algorithm using the given network parameters.
build_cc_vegas ๐Ÿ”’
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 PendingClientTunnel 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.