Skip to main content

Module bridgedesc

Module bridgedesc 

Source
Expand description

BridgeDescMgr - downloads and caches bridges’ router descriptors

Re-exportsΒ§

use std::borrow::Cow; πŸ”’
use std::cmp::Ordering; πŸ”’
use std::collections::BinaryHeap; πŸ”’
use std::collections::HashMap; πŸ”’
use std::collections::HashSet; πŸ”’
use std::collections::VecDeque; πŸ”’
use std::fmt; πŸ”’
use std::fmt::Debug; πŸ”’
use std::fmt::Debug; πŸ”’
use std::fmt::Display; πŸ”’
use std::num::NonZeroU8; πŸ”’
use std::panic::AssertUnwindSafe; πŸ”’
use std::sync::Arc; πŸ”’
use std::sync::Mutex; πŸ”’
use std::sync::MutexGuard; πŸ”’
use std::sync::Weak; πŸ”’
use async_trait::async_trait; πŸ”’
use derive_more::Deref; πŸ”’
use derive_more::DerefMut; πŸ”’
use educe::Educe; πŸ”’
use futures::FutureExt; πŸ”’
use futures::future; πŸ”’
use futures::select; πŸ”’
use futures::stream::BoxStream; πŸ”’
use futures::stream::StreamExt; πŸ”’
use futures::task::SpawnError; πŸ”’
use tracing::debug; πŸ”’
use tracing::info; πŸ”’
use tracing::trace; πŸ”’
use safelog::sensitive; πŸ”’
use tor_basic_utils::retry::RetryDelay; πŸ”’
use tor_checkable::SelfSigned; πŸ”’
use tor_checkable::TimeBound; πŸ”’
use tor_circmgr::CircMgr; πŸ”’
use tor_error::AbsRetryTime; πŸ”’
use tor_error::HasRetryTime; πŸ”’
use tor_error::RetryTime; πŸ”’
use tor_error::ErrorKind; πŸ”’
use tor_error::HasKind; πŸ”’
use tor_error::error_report; πŸ”’
use tor_error::internal; πŸ”’
use tor_guardmgr::bridge::BridgeConfig; πŸ”’
use tor_guardmgr::bridge::BridgeDesc; πŸ”’
use tor_guardmgr::bridge::BridgeDescError; πŸ”’
use tor_guardmgr::bridge::BridgeDescEvent; πŸ”’
use tor_guardmgr::bridge::BridgeDescList; πŸ”’
use tor_guardmgr::bridge::BridgeDescProvider; πŸ”’
use tor_netdoc::doc::routerdesc::RouterDesc; πŸ”’
use tor_rtcompat::Runtime; πŸ”’
use tor_rtcompat::SpawnExt as _; πŸ”’
use web_time_compat::Duration; πŸ”’
use web_time_compat::Instant; πŸ”’
use web_time_compat::SystemTime; πŸ”’
use crate::event::FlagPublisher; πŸ”’
use crate::storage::CachedBridgeDescriptor; πŸ”’
use crate::DirMgrStore; πŸ”’
use crate::DynStore; πŸ”’

ModulesΒ§

mockable πŸ”’
Private module which seals Mockable by containing MockableAPI

StructsΒ§

BridgeDescDownloadConfig
Configuration for the BridgeDescMgr
BridgeDescMgr
Downloader and cache for bridges’ router descriptors
Downloaded πŸ”’
If download was successful, what we obtained
JoinHandle πŸ”’
Dummy task join handle
Manager πŸ”’
The actual manager.
QueuedEntry πŸ”’
Entry in queued
RefetchEntry πŸ”’
Entry in one of the *_schedules
RunningInfo πŸ”’
Value of the entry in running
State πŸ”’
State: our downloaded descriptors (cache), and records of what we’re doing
StateGuard πŸ”’
Writeable reference to State, entitling the holder to disrupt liveness properties.

EnumsΒ§

Dormancy
Active vs dormant state, as far as the bridge descriptor manager is concerned
Error
An error which occurred trying to obtain the descriptor for a particular bridge
StartupError
Error which occurs during bridge descriptor manager startup

TraitsΒ§

Mockable
Mockable internal methods for within the BridgeDescMgr

FunctionsΒ§

process_document πŸ”’
Processes and analyses a textual descriptor document into a Downloaded
timeout_task πŸ”’
Task which waits for the timeout, and requeues bridges that need to be refetched

Type AliasesΒ§

BridgeKey πŸ”’
The key we use in all our data structures