Struct veloren_common::slowjob::SlowJobPool

pub struct SlowJobPool {
    internal: Arc<Mutex<InternalSlowJobPool>>,
}

Provides a Wrapper around rayon threadpool to execute slow-jobs. slow means, the job doesn’t need to not complete within the same tick. DO NOT USE I/O blocking jobs, but only CPU heavy jobs. Jobs run here, will reduce the ammount of threads rayon can use during the main tick.

Configuration

This Pool allows you to configure certain names of jobs and assign them a maximum number of threads # Example Your system has 16 cores, you assign 12 cores for slow-jobs. Then you can configure all jobs with the name CHUNK_GENERATOR to spawn on max 50% (6 = cores)

Spawn Order

• At least 1 job of a configuration is allowed to run if global limit isn’t hit.
• remaining capacities are spread in relation to their limit. e.g. a configuration with double the limit will be sheduled to spawn double the tasks, starting by a round robin.

States

• queued
• spawned
• started
• finished

let threadpool = rayon::ThreadPoolBuilder::new()
    .num_threads(16)
    .build()
    .unwrap();
let pool = SlowJobPool::new(3, 10, Arc::new(threadpool));
pool.configure("CHUNK_GENERATOR", |n| n / 2);
pool.spawn("CHUNK_GENERATOR", move || println!("this is a job"));

Fields

internal: Arc<Mutex<InternalSlowJobPool>>

Implementations

impl SlowJobPool

pub fn new( global_limit: u64, jobs_metrics_cnt: usize, threadpool: Arc<ThreadPool> ) -> Self

pub fn configure<F>(&self, name: &str, f: F)

where F: Fn(u64) -> u64,

configure a NAME to spawn up to f(n) threads, depending on how many threads we globally have available

pub fn try_run<F>(&self, name: &str, f: F) -> Result<SlowJob, ()>

where F: FnOnce() + Send + Sync + 'static,

spawn a new slow job on a certain NAME IF it can run immediately

pub fn spawn<F>(&self, name: &str, f: F) -> SlowJob

where F: FnOnce() + Send + Sync + 'static,

pub fn cancel(&self, job: SlowJob) -> Result<(), SlowJob>

pub fn take_metrics(&self) -> HashMap<String, Vec<JobMetrics>>

Trait Implementations

impl Clone for SlowJobPool

fn clone(&self) -> SlowJobPool

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.