Crate delay_timer[−][src]

Expand description

DelayTimer like crontab is a cyclic task manager with latency properties, but synchronous asynchronous tasks are possible, based on an internal event manager and task scheduler, and supported by the runtime provided by smol and tokio, which makes it easy to manage and dynamic add/cancel/remove is supported.

  • TaskBuilder It is a builder for Task that provides APIs for setting such as maximum number of parallel runs, run content, run identity, run duration, etc.
  • DelayTimerBuilder It is a builder for DelayTimer that provides APIs for setting such as customization runtime and enable status-report.

Usage

First, add this to your Cargo.toml

[dependencies]
delay_timer = "*"

Next:


use anyhow::Result;
use delay_timer::prelude::*;
use std::time::Duration;
use smol::Timer;

fn main() -> Result<()> {
    // Build an DelayTimer that uses the default configuration of the `smol` runtime internally.
    let delay_timer = DelayTimerBuilder::default().build();

    // Develop a print job that runs in an asynchronous cycle.
    // A chain of task instances.
    let task_instance_chain = delay_timer.insert_task(build_task_async_print()?)?;

    // Get the running instance of task 1.
    let task_instance = task_instance_chain.next_with_wait()?;

    // Cancel running task instances.
    task_instance.cancel_with_wait()?;

    // Remove task which id is 1.
    delay_timer.remove_task(1)?;

    // No new tasks are accepted; running tasks are not affected.
    delay_timer.stop_delay_timer()?;

    Ok(())
}

fn build_task_async_print() -> Result<Task, TaskError> {
    let mut task_builder = TaskBuilder::default();

    let body = create_async_fn_body!({
        println!("create_async_fn_body!");

        Timer::after(Duration::from_secs(3)).await;

        println!("create_async_fn_body:i'success");
    });

    task_builder
        .set_task_id(1)
        .set_frequency_repeated_by_seconds(1)
        .set_maximum_parallel_runnable_num(2)
        .spawn(body)
}

Use in asynchronous contexts.


use delay_timer::prelude::*;

use anyhow::Result;

use smol::Timer;
use std::time::Duration;

#[tokio::main]
async fn main() -> Result<()> {
    // In addition to the mixed (smol & tokio) runtime
    // You can also share a tokio runtime with delayTimer, please see api `DelayTimerBuilder::tokio_runtime` for details.

    // Build an DelayTimer that uses the default configuration of the Smol runtime internally.
    let delay_timer = DelayTimerBuilder::default().build();

    // Develop a print job that runs in an asynchronous cycle.
    let task_instance_chain = delay_timer.insert_task(build_task_async_print()?)?;

    // Get the running instance of task 1.
    let task_instance = task_instance_chain.next_with_async_wait().await?;

    // Cancel running task instances.
    task_instance.cancel_with_async_wait().await?;


    // Remove task which id is 1.
    delay_timer.remove_task(1)?;

    // No new tasks are accepted; running tasks are not affected.
    Ok(delay_timer.stop_delay_timer()?)
}

fn build_task_async_print() -> Result<Task, TaskError> {
    let mut task_builder = TaskBuilder::default();

    let body = create_async_fn_body!({
        println!("create_async_fn_body!");

        Timer::after(Duration::from_secs(3)).await;

        println!("create_async_fn_body:i'success");
    });

    task_builder
        .set_task_id(1)
        .set_frequency_repeated_by_seconds(6)
        .set_maximum_parallel_runnable_num(2)
        .spawn(body)
}

Capture the specified environment information and build the closure & task:

#[macro_use]
use delay_timer::prelude::*;

use std::sync::atomic::{
    AtomicUsize,
    Ordering::{Acquire, Release},
};
use std::sync::Arc;
use std::time::Duration;
use smol::Timer;


let delay_timer = DelayTimer::new();

let share_num = Arc::new(AtomicUsize::new(0));
let share_num_bunshin = share_num.clone();

let body = create_async_fn_body!((share_num_bunshin){
    share_num_bunshin_ref.fetch_add(1, Release);
    Timer::after(Duration::from_secs(9)).await;
    share_num_bunshin_ref.fetch_sub(1, Release);
});

let task = TaskBuilder::default()
    .set_frequency_count_down_by_seconds(1, 9)
    .set_task_id(1)
    .set_maximum_parallel_runnable_num(3)
    .spawn(body).expect("");

delay_timer.add_task(task).ok();

Building dynamic future tasks:

#[macro_use]
use delay_timer::prelude::*;

use std::str::FromStr;
use std::sync::atomic::{
    AtomicUsize,
    Ordering::{Acquire, Release},
};
use std::sync::{atomic::AtomicI32, Arc};
use std::thread::{self, park_timeout};
use std::time::Duration;
use smol::Timer;
use hyper::{Client, Uri};



fn build_task(mut task_builder: TaskBuilder) -> Result<Task, TaskError> {
    let body = generate_closure_template(String::from("dynamic"));

    task_builder
        .set_frequency_repeated_by_seconds(8)
        .set_task_id(2)
        .set_maximum_running_time(5)
        .spawn(body)
}

pub fn generate_closure_template(
    name: String,
) -> impl Fn(TaskContext) -> Box<dyn DelayTaskHandler> + 'static + Send + Sync {
    move |context| {
        let future_inner = async_template(get_timestamp() as i32, name.clone());

        let future = async move {
            future_inner.await;
            context.finish_task(None).await;
        };

        create_delay_task_handler(async_spawn(future))
    }
}

pub async fn async_template(id: i32, name: String) -> AnyResult<()> {
    let client = Client::new();

    let url = format!("http://httpbin.org/get?id={}&name={}", id, name);
    let uri: Uri = url.parse()?;
    let res = client.get(uri).await?;
    println!("Response: {}", res.status());
    // Concatenate the body stream into a single buffer...
    let buf = hyper::body::to_bytes(res).await?;
    println!("body: {:?}", buf);
    Ok(())
}

Re-exports

pub use anyhow;
pub use cron_clock;
pub use snowflake;

Modules

entity

DelayTimer is a cyclic task manager with latency properties, based on an internal event manager and task scheduler, and supported by the runtime provided by smol, which makes it easy to manage asynchronous/synchronous/scripted cyclic tasks.

error

Public error of delay-timer..

macros

This macro module provides the declaration macros used for the conditional compilation of lib, and the helper macros provide cycle asynchronous tasks for the user.

prelude

A “prelude” for users of the delay-timer crate.

timer

timer is the core module of the library , it can provide an API for task building , task scheduling , event handling , resource recovery .

utils

utils is a tool module that provides easy shell-command parsing, and functions that generate closures.

Macros

create_async_fn_body

Create a closure that return a DelayTaskHandel by macro.

create_async_fn_tokio_bodytokio-support

Create a closure that return a DelayTaskHandel by macro.