Struct Scanner

pub struct Scanner { /* private fields */ }

A utility to test for two hop circuits

It’s mainly used for completing the IncompleteWork into CompletedWork by attempting to create a circuit, it distributes the IncompleteWork provided to it through the push_incomplete_work method, among all the Client it has spawned internally. These Client basically hold clones of CircMgr and underneath they call the method to build circuit through the CircuitBuilder abstracted by CircMgr

If we were to push 1000 IncompleteWork into internal channel of the Scanner, then the speed of completion of those work whould depend mainly on no of clients we spawned within the Scanner, which can be controlled by passing a u8 value inside of Scanner::new()

Implementations

impl Scanner

pub async fn new( no_of_parallel_circuit_builds: u32, netdir_provider: Arc<NetDirProvider>, circmgr: Arc<CircMgr<PreferredRuntime>>, ) -> Result<Self>

Create a Scanner, behind the scenes it creates a single arti TorClient and it’s DirMgr, CircMgr is used for all the so called Client

We only have to provide no of Client we wanna spin in the pool, just make sure it’s not 0

pub fn push_incomplete_work(&self, work: IncompleteWork) -> Result<()>

Push IncompleteWork into the internal buffer of the Scanner

pub async fn recv_completed_work(&self) -> Option<CompletedWork>

Receive the CompletedWork over time from the internal buffer of the Scanner