Struct Manager

struct Manager<R: Runtime, M: Mockable<R>> {
    state: Mutex<State>,
    runtime: R,
    circmgr: M::CircMgr,
    store: Arc<Mutex<Box<dyn Store>>>,
    mockable: M,
}

Available on crate feature bridge-client only.

The actual manager.

Fields

state: Mutex<State>

The mutable state

runtime: R

Runtime, used for tasks and sleeping

circmgr: M::CircMgr

Circuit manager, used for creating circuits

store: Arc<Mutex<Box<dyn Store>>>

Persistent state store

mockable: M

Mock for testing, usually ()

Implementations

impl<R: Runtime, M: Mockable<R>> Manager<R, M>

fn lock_then_process<'s>(self: &'s Arc<Self>) -> StateGuard<'s, R, M>

Obtain a lock on state, for functions that want to disrupt liveness properties

When StateGuard is dropped, the liveness properties will be restored by making whatever progress is required.

See State.

fn lock_only(&self) -> MutexGuard<'_, State>

Obtains the lock on state.

Caller ought not to modify state so as to invalidate invariants or liveness properties. Callers which are part of the algorithms in this crate ought to consider lock_then_process instead.

impl<R: Runtime, M: Mockable<R>> Manager<R, M>

async fn download_descriptor( &self, mockable: M, bridge: &BridgeConfig, config: &BridgeDescDownloadConfig, ) -> Result<Downloaded, Error>

Downloads a descriptor.

The core of the descriptor download task launched by State::consider_launching.

Uses Mockable::download to actually get the document. So most of this function is parsing and checking.

The returned value is precisely the got input to record_download_outcome.