Struct yatp::pool::Builder

pub struct Builder { /* fields omitted */ }

A builder for the thread pool.

Implementations

impl Builder

pub fn new(name_prefix: impl Into<String>) -> Builder

Create a builder using the given name prefix.

pub fn max_thread_count(&mut self, count: usize) -> &mut Self

Sets the maximum number of running threads at the same time.

pub fn min_thread_count(&mut self, count: usize) -> &mut Self

Sets the minimum number of running threads at the same time.

pub fn max_inplace_spin(&mut self, count: usize) -> &mut Self

Sets the maximum tries to rerun an unfinished task before pushing back to queue.

pub fn max_idle_time(&mut self, time: Duration) -> &mut Self

Sets the maximum allowed idle time for a thread. Thread will only be woken up when algorithm thinks it needs more worker.

pub fn max_wait_time(&mut self, time: Duration) -> &mut Self

Sets the maximum time to wait for a task before increasing the running thread slots.

pub fn wake_backoff(&mut self, time: Duration) -> &mut Self

Sets the minimum interval between waking a thread.

pub fn alloc_slot_backoff(&mut self, time: Duration) -> &mut Self

Sets the minimum interval between increasing running threads.

pub fn stack_size(&mut self, size: usize) -> &mut Self

Sets the stack size of the spawned threads.

pub fn freeze<T>(&self) -> (Remote<T>, LazyBuilder<T>) where
    T: TaskCell + Send, 

Freezes the configurations and returns the task scheduler and a builder to for lazy spawning threads.

It internally uses single level queue to setup the pool.

In some cases, especially building up a large application, a task scheduler is required before spawning new threads. You can use this to separate the construction and starting.

pub fn freeze_with_queue<T>(
    &self,
    queue_type: QueueType
) -> (Remote<T>, LazyBuilder<T>) where
    T: TaskCell + Send, 

Freezes the configurations and returns the task scheduler and a builder to for lazy spawning threads.

queue_builder is a closure that creates a task queue. It accepts the number of local queues and returns the task injector and local queues.

In some cases, especially building up a large application, a task scheduler is required before spawning new threads. You can use this to separate the construction and starting.

pub fn build_callback_pool(&self) -> ThreadPool<TaskCell>

Spawns a callback pool.

It setups the pool with single level queue.

pub fn build_future_pool(&self) -> ThreadPool<TaskCell>

Spawns a future pool.

It setups the pool with single level queue.

pub fn build_multilevel_future_pool(&self) -> ThreadPool<TaskCell>

Spawns a multilevel future pool.

It setups the pool with multi level queue.

pub fn build_with_queue_and_runner<T, B>(
    &self,
    queue_type: QueueType,
    runner_builder: B
) -> ThreadPool<T> where
    T: TaskCell + Send + 'static,
    B: RunnerBuilder,
    B::Runner: Runner<TaskCell = T> + Send + 'static, 

Spawns the thread pool immediately.

queue_builder is a closure that creates a task queue. It accepts the number of local queues and returns the task injector and local queues.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.