Struct arti_bench::Benchmark

pub(crate) struct Benchmark<R> where
    R: Runtime,  {
    pub(crate) runtime: R,
    pub(crate) connect_addr: SocketAddr,
    pub(crate) samples: usize,
    pub(crate) streams_per_circ: usize,
    pub(crate) circs_per_sample: usize,
    pub(crate) upload_payload: Arc<[u8]>,
    pub(crate) download_payload: Arc<[u8]>,
    pub(crate) results: HashMap<BenchmarkType, BenchmarkResults>,
}

A helper struct for running benchmarks

Fields

runtime: R

connect_addr: SocketAddr

samples: usize

streams_per_circ: usize

circs_per_sample: usize

upload_payload: Arc<[u8]>

download_payload: Arc<[u8]>

results: HashMap<BenchmarkType, BenchmarkResults>

All benchmark results conducted, indexed by benchmark type.

Implementations

impl<R: Runtime> Benchmark<R>

pub(crate) fn run<F, G, S, E>(
    &mut self,
    ty: BenchmarkType,
    stream_generator: F
) -> Result<()> where
    F: FnMut(usize) -> G,
    G: Future<Output = Result<S, E>>,
    S: AsyncRead + AsyncWrite + Unpin,
    E: Error + Send + Sync + 'static, 

Run a type of benchmark (ty), performing self.samples benchmark runs, using self.circs_per_sample concurrent circuits, and self.streams_per_circ concurrent streams on each circuit.

Uses stream_generator, function that returns futures that themselves generate streams, in order to obtain the required number of streams to run the test over. The function takes an index of the current run.

pub(crate) fn without_arti(&mut self) -> Result<()>

Benchmark without Arti on loopback.

pub(crate) fn with_proxy(&mut self, addr: &str) -> Result<()>

Benchmark through a SOCKS5 proxy at address addr.

pub(crate) fn with_arti(&mut self, tcc: TorClientConfig) -> Result<()>

Benchmark through Arti, using the provided TorClientConfig.