Available on crate feature
hs-common
only.Expand description
Manage a pool of circuits for usage with onion services.
Modules§
- config 🔒
- Configuration logic for
HsCircPool
. - pool 🔒
- An internal pool object that we use to implement HsCircPool.
Structs§
- HsCirc
Pool - An object to provide circuits for implementing onion services.
- HsCirc
Pool 🔒Inner - An object to provide circuits for implementing onion services.
- HsCirc
Stem 🔒 - A hidden service circuit stem.
- Inner 🔒
- The mutable state of an
HsCircPool
Enums§
- HsCirc
Kind - The (onion-service-related) purpose for which a given circuit is going to be used.
- HsCirc
Stem 🔒Kind - A kind of hidden service circuit stem.
- NoRelay
ForPath 🔒Ent - A possible error condition when trying to look up a PathEntry
Traits§
- HsCirc
Pool Config - Configuration for an
HsCircPool
.
Functions§
- circuit_
compatible_ 🔒with_ target - Return true if we can extend a pre-built circuit
circ
totarget
. - 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
totarget
.