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()

TaskId is assigned when the task is inserted into the timing wheel.

定时器任务

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

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

TaskId 在任务插入到时间轮时分配

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

TaskId will be assigned when the task is inserted into the timing wheel. 创建一个新的一次性定时器任务

参数

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

注意

TaskId 将在任务插入到时间轮时分配

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

Create a new periodic timer task

Parameters

• initial_delay: Initial delay before first execution
• interval: Interval between subsequent executions
• callback: Callback function, optional
• buffer_size: Maximum pending Called notifications; None is unbounded

Note

TaskId will be assigned when the task is inserted into the timing wheel. The interval must be greater than zero. The timing wheel also requires it to be at least the configured L0 tick duration.

Returns Err(TimerError::InvalidConfiguration) for a zero interval.

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

参数

• initial_delay: 首次执行前的初始延迟
• interval: 后续执行之间的间隔
• callback: 回调函数，可选
• buffer_size: 待消费 Called 通知的最大数量；None 表示无界

注意

TaskId 将在任务插入到时间轮时分配。 有界模式超出的 Called 通知可通过 PeriodicCompletionReceiver::dropped_notifications 查询。

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