Struct PreemptiveCircuitConfig 

pub struct PreemptiveCircuitConfig {
    pub(crate) disable_at_threshold: usize,
    pub(crate) initial_predicted_ports: Vec<u16>,
    pub(crate) prediction_lifetime: Duration,
    pub(crate) min_exit_circs_for_port: usize,
}

Configuration for preemptive circuits.

Preemptive circuits are built ahead of time, to anticipate client need. This object configures the way in which this demand is anticipated and in which these circuits are constructed.

This type is immutable once constructed. To create an object of this type, use PreemptiveCircuitConfigBuilder.

Except as noted, this configuration can be changed on a running Arti client.

Fields

disable_at_threshold: usize

If we have at least this many available circuits, we suspend construction of preemptive circuits. whether our available circuits support our predicted exit ports or not.

initial_predicted_ports: Vec<u16>

At startup, which exit ports should we expect that the client will want?

(Over time, new ports are added to the predicted list, in response to what the client has actually requested.)

This value cannot be changed on a running Arti client, because doing so would be meaningless.

The default is [80, 443].

prediction_lifetime: Duration

After we see the client request a connection to a new port, how long should we predict that the client will still want to have circuits available for that port?

min_exit_circs_for_port: usize

How many available circuits should we try to have, at minimum, for each predicted exit port?

Implementations

impl PreemptiveCircuitConfig

pub fn builder() -> PreemptiveCircuitConfigBuilder

Return a new [PreemptiveCircuitConfig Builder] to construct an instance of this type.

Trait Implementations

impl AsRef<PreemptiveCircuitConfig> for TestConfig

fn as_ref(&self) -> &PreemptiveCircuitConfig

Converts this type into a shared reference of the (usually inferred) input type.

impl Buildable for PreemptiveCircuitConfig

type Builder = PreemptiveCircuitConfigBuilder

The type that constructs this Buildable.

fn builder() -> PreemptiveCircuitConfigBuilder

Return a new Builder for this type.

impl Clone for PreemptiveCircuitConfig

fn clone(&self) -> PreemptiveCircuitConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PreemptiveCircuitConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PreemptiveCircuitConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PreemptiveCircuitConfig

fn eq(&self, other: &PreemptiveCircuitConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PreemptiveCircuitConfig

impl StructuralPartialEq for PreemptiveCircuitConfig