Struct TaskController

pub struct TaskController { /* private fields */ }

Implementations

impl TaskController

pub fn spawn_abortable<F, T>(&self, future: F) -> JoinHandle<()>

where F: Future<Output = T> + Send + 'static, T: Send + 'static,

Spawns a task that can be later terminated by call to TaskController::terminate_all(). Task output is ignored.

pub fn spawn_abortable_with_rt<F, T>( &self, rt: ZRuntime, future: F, ) -> JoinHandle<()>

where F: Future<Output = T> + Send + 'static, T: Send + 'static,

Spawns a task using a specified runtime that can be later terminated by call to TaskController::terminate_all(). Task output is ignored.

pub fn get_cancellation_token(&self) -> CancellationToken

pub fn spawn<F, T>(&self, future: F) -> JoinHandle<()>

where F: Future<Output = T> + Send + 'static, T: Send + 'static,

Spawns a task that can be cancelled via cancellation of a token obtained by TaskController::get_cancellation_token(), or that can run to completion in finite amount of time. It can be later terminated by call to TaskController::terminate_all().

pub fn spawn_with_rt<F, T>(&self, rt: ZRuntime, future: F) -> JoinHandle<()>

where F: Future<Output = T> + Send + 'static, T: Send + 'static,

Spawns a task that can be cancelled via cancellation of a token obtained by TaskController::get_cancellation_token(), or that can run to completion in finite amount of time, using a specified runtime. It can be later aborted by call to TaskController::terminate_all().

pub fn terminate_all(&self, timeout: Duration) -> usize

Attempts tp terminate all previously spawned tasks The caller must ensure that all tasks spawned with TaskController::spawn() or TaskController::spawn_with_rt() can yield in finite amount of time either because they will run to completion or due to cancellation of token acquired via TaskController::get_cancellation_token(). Tasks spawned with TaskController::spawn_abortable() or TaskController::spawn_abortable_with_rt() will be aborted (i.e. terminated upon next await call). The call blocks until all tasks yield or timeout duration expires. Returns 0 in case of success, number of non terminated tasks otherwise.

pub async fn terminate_all_async(&self, timeout: Duration) -> usize

Async version of TaskController::terminate_all().

Trait Implementations

impl Clone for TaskController

fn clone(&self) -> TaskController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for TaskController

fn default() -> Self

Returns the “default value” for a type.