Skip to main content

Module hspool

Module hspool 

Source
Expand description

Manage a pool of circuits for usage with onion services.

Re-exportsยง

use std::ops::Deref; ๐Ÿ”’
use std::sync::Arc; ๐Ÿ”’
use std::sync::Mutex; ๐Ÿ”’
use std::sync::Weak; ๐Ÿ”’
use crate::AbstractTunnel; ๐Ÿ”’
use crate::CircMgr; ๐Ÿ”’
use crate::CircMgrInner; ๐Ÿ”’
use crate::ClientOnionServiceDataTunnel; ๐Ÿ”’
use crate::ClientOnionServiceDirTunnel; ๐Ÿ”’
use crate::ClientOnionServiceIntroTunnel; ๐Ÿ”’
use crate::Error; ๐Ÿ”’
use crate::Result; ๐Ÿ”’
use crate::ServiceOnionServiceDataTunnel; ๐Ÿ”’
use crate::ServiceOnionServiceDirTunnel; ๐Ÿ”’
use crate::ServiceOnionServiceIntroTunnel; ๐Ÿ”’
use crate::build::TunnelBuilder; ๐Ÿ”’
use crate::build::onion_circparams_from_netparams; ๐Ÿ”’
use crate::mgr::AbstractTunnelBuilder; ๐Ÿ”’
use crate::path::hspath::hs_stem_terminal_hop_usage; ๐Ÿ”’
use crate::timeouts; ๐Ÿ”’
use futures::StreamExt; ๐Ÿ”’
use futures::TryFutureExt; ๐Ÿ”’
use once_cell::sync::OnceCell; ๐Ÿ”’
use tor_error::Bug; ๐Ÿ”’
use tor_error::debug_report; ๐Ÿ”’
use tor_error::bad_api_usage; ๐Ÿ”’
use tor_error::internal; ๐Ÿ”’
use tor_guardmgr::VanguardMode; ๐Ÿ”’
use tor_linkspec::CircTarget; ๐Ÿ”’
use tor_linkspec::HasRelayIds as _; ๐Ÿ”’
use tor_linkspec::IntoOwnedChanTarget; ๐Ÿ”’
use tor_linkspec::OwnedChanTarget; ๐Ÿ”’
use tor_linkspec::OwnedCircTarget; ๐Ÿ”’
use tor_netdir::NetDir; ๐Ÿ”’
use tor_netdir::NetDirProvider; ๐Ÿ”’
use tor_netdir::Relay; ๐Ÿ”’
use tor_proto::client::circuit; ๐Ÿ”’
use tor_proto::client::circuit::CircParameters; ๐Ÿ”’
use tor_relay_selection::LowLevelRelayPredicate; ๐Ÿ”’
use tor_relay_selection::RelayExclusion; ๐Ÿ”’
use tor_rtcompat::Runtime; ๐Ÿ”’
use tor_rtcompat::SleepProviderExt; ๐Ÿ”’
use tor_rtcompat::SpawnExt; ๐Ÿ”’
use tor_rtcompat::scheduler::TaskHandle; ๐Ÿ”’
use tor_rtcompat::scheduler::TaskSchedule; ๐Ÿ”’
use tracing::debug; ๐Ÿ”’
use tracing::instrument; ๐Ÿ”’
use tracing::instrument; ๐Ÿ”’
use tracing::trace; ๐Ÿ”’
use tracing::warn; ๐Ÿ”’
use web_time_compat::Duration; ๐Ÿ”’
use web_time_compat::Instant; ๐Ÿ”’
use web_time_compat::SystemTime; ๐Ÿ”’
use std::result::Result as StdResult; ๐Ÿ”’
pub use config::HsCircPoolConfig;
use self::pool::HsCircPrefs; ๐Ÿ”’
use crate::path::hspath::select_middle_for_vanguard_circ; ๐Ÿ”’

Modulesยง

config ๐Ÿ”’
Configuration logic for HsCircPool.
pool ๐Ÿ”’
An internal pool object that we use to implement HsCircPool.

Structsยง

HsCircPool
An object to provide circuits for implementing onion services.
HsCircPoolInner ๐Ÿ”’
An object to provide circuits for implementing onion services.
HsCircStem ๐Ÿ”’
A hidden service circuit stem.
Inner ๐Ÿ”’
The mutable state of an HsCircPool

Enumsยง

HsCircKind
The (onion-service-related) purpose for which a given circuit is going to be used.
HsCircStemKind ๐Ÿ”’
A kind of hidden service circuit stem.
NoRelayForPathEnt ๐Ÿ”’
A possible error condition when trying to look up a PathEntry

Functionsยง

circuit_compatible_with_target ๐Ÿ”’
Return true if we can extend a pre-built circuit circ to target.
circuit_still_useable ๐Ÿ”’
Return true if we can still use a given pre-build circuit.
launch_hs_circuits_as_needed ๐Ÿ”’
Background task to launch onion circuits as needed.
relay_for_path_ent ๐Ÿ”’
Look up a relay in a netdir corresponding to ent
remove_unusable_circuits ๐Ÿ”’
Background task to remove unusable circuits whenever the directory changes.
vanguards_circuit_compatible_with_target ๐Ÿ”’
Return true if we can extend a pre-built vanguards circuit circ to target.