Struct tor_circmgr::CircMgr
source · [−]pub struct CircMgr<R: Runtime> { /* private fields */ }
Expand description
A Circuit Manager (CircMgr) manages a set of circuits, returning them when they’re suitable, and launching them if they don’t already exist.
Right now, its notion of “suitable” is quite rudimentary: it just believes in two kinds of circuits: Exit circuits, and directory circuits. Exit circuits are ones that were created to connect to a set of ports; directory circuits were made to talk to directory caches.
Implementations
sourceimpl<R: Runtime> CircMgr<R>
impl<R: Runtime> CircMgr<R>
sourcepub fn new<SM, CFG: CircMgrConfig>(
config: &CFG,
storage: SM,
runtime: &R,
chanmgr: Arc<ChanMgr<R>>
) -> Result<Arc<Self>> where
SM: StateMgr + Send + Sync + 'static,
pub fn new<SM, CFG: CircMgrConfig>(
config: &CFG,
storage: SM,
runtime: &R,
chanmgr: Arc<ChanMgr<R>>
) -> Result<Arc<Self>> where
SM: StateMgr + Send + Sync + 'static,
Construct a new circuit manager.
Usage note
For the manager to work properly, you will need to call CircMgr::launch_background_tasks
.
sourcepub fn launch_background_tasks<D>(
self: &Arc<Self>,
runtime: &R,
dir_provider: &Arc<D>,
state_mgr: FsStateMgr
) -> Result<Vec<TaskHandle>> where
D: NetDirProvider + 'static + ?Sized,
pub fn launch_background_tasks<D>(
self: &Arc<Self>,
runtime: &R,
dir_provider: &Arc<D>,
state_mgr: FsStateMgr
) -> Result<Vec<TaskHandle>> where
D: NetDirProvider + 'static + ?Sized,
Launch the periodic daemon tasks required by the manager to function properly.
Returns a set of TaskHandle
s that can be used to manage the daemon tasks.
sourcepub fn reconfigure<CFG: CircMgrConfig>(
&self,
new_config: &CFG,
how: Reconfigure
) -> Result<(), ReconfigureError>
pub fn reconfigure<CFG: CircMgrConfig>(
&self,
new_config: &CFG,
how: Reconfigure
) -> Result<(), ReconfigureError>
Try to change our configuration settings to new_config
.
The actual behavior here will depend on the value of how
.
sourcepub fn reload_persistent_state(&self) -> Result<()>
pub fn reload_persistent_state(&self) -> Result<()>
Reload state from the state manager.
We only call this method if we don’t have the lock on the state files. If we have the lock, we only want to save.
sourcepub fn upgrade_to_owned_persistent_state(&self) -> Result<()>
pub fn upgrade_to_owned_persistent_state(&self) -> Result<()>
Switch from having an unowned persistent state to having an owned one.
Requires that we hold the lock on the state files.
sourcepub fn store_persistent_state(&self) -> Result<bool>
pub fn store_persistent_state(&self) -> Result<bool>
Flush state to the state manager, if there is any unsaved state and we have the lock.
Return true if we saved something; false if we didn’t have the lock.
sourcepub fn update_network_parameters(&self, p: &NetParameters)
👎 Deprecated: There is no need to call this function if you have used launch_background_tasks
pub fn update_network_parameters(&self, p: &NetParameters)
There is no need to call this function if you have used launch_background_tasks
Reconfigure this circuit manager using the latest set of network parameters.
This is deprecated as a public function: launch_background_tasks
now
ensures that this happens as needed.
sourcepub fn netdir_is_sufficient(&self, netdir: &NetDir) -> bool
pub fn netdir_is_sufficient(&self, netdir: &NetDir) -> bool
Return true if netdir
has enough information to be used for this
circuit manager.
(This will check whether the netdir is missing any primary guard microdescriptors)
sourcepub fn update_network(&self, netdir: &NetDir)
👎 Deprecated: There is no need to call this function if you have used launch_background_tasks
pub fn update_network(&self, netdir: &NetDir)
There is no need to call this function if you have used launch_background_tasks
Reconfigure this circuit manager using the latest network directory.
This function is deprecated: launch_background_tasks
now makes sure that this happens as needed.
sourcepub async fn get_or_launch_dir(&self, netdir: DirInfo<'_>) -> Result<ClientCirc>
pub async fn get_or_launch_dir(&self, netdir: DirInfo<'_>) -> Result<ClientCirc>
Return a circuit suitable for sending one-hop BEGINDIR streams, launching it if necessary.
sourcepub async fn get_or_launch_exit(
&self,
netdir: DirInfo<'_>,
ports: &[TargetPort],
isolation: StreamIsolation
) -> Result<ClientCirc>
pub async fn get_or_launch_exit(
&self,
netdir: DirInfo<'_>,
ports: &[TargetPort],
isolation: StreamIsolation
) -> Result<ClientCirc>
Return a circuit suitable for exiting to all of the provided
ports
, launching it if necessary.
If the list of ports is empty, then the chosen circuit will still end at some exit.
sourcepub fn retire_circ(&self, circ_id: &UniqId)
pub fn retire_circ(&self, circ_id: &UniqId)
If circ_id
is the unique identifier for a circuit that we’re
keeping track of, don’t give it out for any future requests.
sourcepub fn note_external_failure(
&self,
target: &impl ChanTarget,
external_failure: ExternalActivity
)
pub fn note_external_failure(
&self,
target: &impl ChanTarget,
external_failure: ExternalActivity
)
Record that a failure occurred on a circuit with a given guard, in a way that makes us unwilling to use that guard for future circuits.
sourcepub fn note_external_success(
&self,
target: &impl ChanTarget,
external_activity: ExternalActivity
)
pub fn note_external_success(
&self,
target: &impl ChanTarget,
external_activity: ExternalActivity
)
Record that a success occurred on a circuit with a given guard, in a way that makes us possibly willing to use that guard for future circuits.
sourcepub fn skew_events(&self) -> ClockSkewEvents
pub fn skew_events(&self) -> ClockSkewEvents
Return a stream of events about our estimated clock skew; these events
are None
when we don’t have enough information to make an estimate,
and Some(
SkewEstimate
)
otherwise.
Note that this stream can be lossy: if the estimate changes more than one before you read from the stream, you might only get the most recent update.
Trait Implementations
Auto Trait Implementations
impl<R> !RefUnwindSafe for CircMgr<R>
impl<R> Send for CircMgr<R>
impl<R> Sync for CircMgr<R>
impl<R> Unpin for CircMgr<R>
impl<R> !UnwindSafe for CircMgr<R>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
sourcefn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
sourcefn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
sourcefn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
sourceimpl<T> DowncastSync for T where
T: Any + Send + Sync,
impl<T> DowncastSync for T where
T: Any + Send + Sync,
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more