Struct TimerTask 

pub struct TimerTask { /* private fields */ }

Timer Task

Users interact via a two-step API

1. Create task using TimerTask::new_oneshot() or TimerTask::new_periodic()
2. Register task using TimerWheel::register() or TimerService::register()

定时器任务

用户通过两步 API 与定时器交互

1. 使用 TimerTask::new_oneshot() 或 TimerTask::new_periodic() 创建任务
2. 使用 TimerWheel::register() 或 TimerService::register() 注册任务

Implementations

impl TimerTask

pub fn new_oneshot(delay: Duration, callback: Option<CallbackWrapper>) -> Self

Create a new one-shot timer task

Parameters

• delay: Delay duration before task execution
• callback: Callback function, optional

Note

This is an internal method, users should use TimerWheel::create_task() or TimerService::create_task() to create tasks.

创建一个新的一次性定时器任务

参数

• delay: 任务执行前的延迟时间
• callback: 回调函数，可选

pub fn new_periodic( initial_delay: Duration, interval: Duration, callback: Option<CallbackWrapper>, buffer_size: Option<NonZeroU16>, ) -> Self

Create a new periodic timer task

Parameters

• initial_delay: Initial delay before first execution
• interval: Interval between subsequent executions
• callback: Callback function, optional

Note

This is an internal method, users should use TimerWheel::create_periodic_task() or TimerService::create_periodic_task() to create tasks.

创建一个新的周期性定时器任务

参数

• initial_delay: 首次执行前的初始延迟
• interval: 后续执行之间的间隔
• callback: 回调函数，可选

pub fn get_id(&self) -> TaskId

Get task ID

获取任务 ID

Examples (示例)

use kestrel_timer::TimerTask;
use std::time::Duration;
 
let task = TimerTask::new_oneshot(Duration::from_secs(1), None);
let task_id = task.get_id();
println!("Task ID: {:?}", task_id);

pub fn get_task_type(&self) -> &TaskType

Get task type

获取任务类型

pub fn get_interval(&self) -> Option<Duration>

Get the interval for periodic tasks

Returns None for one-shot tasks

获取周期任务的间隔时间

对于一次性任务返回 None