| Crates.io | kestrel-protocol-timer |
| lib.rs | kestrel-protocol-timer |
| version | 0.1.12 |
| created_at | 2025-10-26 05:17:45.842439+00 |
| updated_at | 2025-10-31 16:23:03.847441+00 |
| description | 基于时间轮(Timing Wheel)算法的高性能异步定时器系统 |
| homepage | https://github.com/ShaoG-R/kestrel-protocol-timer |
| repository | https://github.com/ShaoG-R/kestrel-protocol-timer |
| max_upload_size | |
| id | 1900959 |
| size | 352,890 |
基于时间轮(Timing Wheel)算法的高性能异步定时器系统
[!NOTE] 当前库已改名 请你到 kestrel-timer查看最新实现 本库已废弃
kestrel-protocol-timer 是一个基于时间轮(Timing Wheel)算法实现的高性能异步定时器库,专为 Rust 和 tokio 异步运行时设计。它能够高效管理大规模并发定时器任务,提供 O(1) 时间复杂度的插入和删除操作。
FxHashMap 减少哈希冲突,parking_lot::Mutex 提供更快的锁机制parking_lot::Mutex 提供高性能的锁机制use kestrel_protocol_timer::{TimerWheel, CallbackWrapper};
use std::time::Duration;
#[tokio::main]
async fn main() {
// 创建定时器(使用默认配置)
let timer = TimerWheel::with_defaults();
// 两步式 API:创建任务 + 注册
let callback = Some(CallbackWrapper::new(|| async {
println!("定时器触发!");
}));
let task = TimerWheel::create_task(Duration::from_secs(1), callback);
let handle = timer.register(task);
// 等待定时器完成
handle.into_completion_receiver().0.await.ok();
println!("定时器执行完成");
}
在 Cargo.toml 中添加依赖:
[dependencies]
kestrel-protocol-timer = "0.1.0"
tokio = { version = "1.48", features = ["full"] }
时间轮是一个环形数组结构,每个槽位(slot)存储一组到期时间相近的定时器任务。时间轮以固定的频率(tick)推进,当指针移动到某个槽位时,该槽位中的所有任务会被检查是否到期。
本实现采用**双层时间轮(Hierarchical Timing Wheel)**架构,以高效处理不同时间范围的任务:
┌─────────────────────────────────────────────────────────┐
│ L1 层(高层) │
│ 槽位数:64 | Tick: 1000ms | 覆盖范围:64秒 │
│ │
│ 槽位 0 槽位 1 槽位 2 ... 槽位 63 │
│ ┌────┐ ┌────┐ ┌────┐ ┌────┐ │
│ │长任│ │长任│ │ │ │ │ │
│ │务A │ │务B │ │ │ │ │ │
│ └────┘ └────┘ └────┘ └────┘ │
│ ↓ 降级到 L0 │
└─────────────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────┐
│ L0 层(底层) │
│ 槽位数:512 | Tick: 10ms | 覆盖范围:5.12秒 │
│ │
│ 槽位 0 槽位 1 槽位 2 ... 槽位 511 │
│ ┌────┐ ┌────┐ ┌────┐ ┌────┐ │
│ │任务│ │任务│ │任务│ │ │ │
│ │A/B │ │C/D │ │E │ │ │ │
│ └────┘ └────┘ └────┘ └────┘ │
│ ▲ │
│ │ 当前指针(current_tick) │
└─────────────────────────────────────────────────────────┘
L0 层(底层 - 高精度):
L1 层(高层 - 长时间):
层级比率:L1 tick / L0 tick = 1000ms / 10ms = 100
插入任务:
推进时间轮:
任务降级:
触发任务:
执行回调:在独立的 tokio 任务中执行回调函数
相比单层时间轮,分层架构具有以下优势:
性能优化:
advance() 时的条件判断开销内存效率:
时间范围扩展:
精度保证:
主定时器接口,提供定时器的创建、调度和管理功能。
pub struct TimerWheel {
wheel: Arc<Mutex<Wheel>>,
driver_handle: JoinHandle<()>,
}
职责:
分层时间轮的核心实现,负责任务的存储、查找、触发和层级管理。
pub struct Wheel {
l0: WheelLayer, // L0 层(底层 - 高精度)
l1: WheelLayer, // L1 层(高层 - 长时间)
l1_tick_ratio: u64, // L1 tick 相对于 L0 tick 的比率
task_index: FxHashMap<TaskId, TaskLocation>, // 任务索引
batch_config: BatchConfig, // 批处理配置
l0_capacity_ms: u64, // L0 层容量(毫秒)
l1_capacity_ticks: u64, // L1 层容量(tick 数)
}
struct WheelLayer {
slots: Vec<Vec<TimerTask>>, // 槽位数组
current_tick: u64, // 当前 tick
slot_count: usize, // 槽位数量
tick_duration: Duration, // tick 时长
tick_duration_ms: u64, // 缓存的 tick 时长(毫秒)
slot_mask: usize, // 槽位掩码(用于快速取模)
}
职责:
定时器句柄,用于管理单个或批量定时器的生命周期。
pub struct TimerHandle {
task_id: TaskId,
wheel: Arc<Mutex<Wheel>>,
completion_rx: CompletionReceiver,
}
职责:
基于 Actor 模式的定时器服务管理器,提供集中式的定时器管理。
pub struct TimerService {
command_tx: mpsc::Sender<ServiceCommand>,
timeout_rx: Option<mpsc::Receiver<TaskId>>,
actor_handle: Option<JoinHandle<()>>,
wheel: Arc<Mutex<Wheel>>,
}
职责:
定时器任务的封装,包含任务的元数据和回调函数。
pub struct TimerTask {
id: TaskId,
deadline_tick: u64,
rounds: u32,
callback: Option<CallbackWrapper>,
completion_notifier: CompletionNotifier,
}
分层时间轮架构:
高效锁机制:使用 parking_lot::Mutex 替代标准库 Mutex,减少锁开销
优化哈希表:使用 FxHashMap(rustc-hash)替代标准 HashMap,减少哈希冲突
位运算优化:
& (slot_count - 1) 替代 % slot_countslot_mask)缓存优化:
l0_capacity_ms, l1_capacity_ticks)determine_layer 中的重复计算独立任务执行:回调函数在独立的 tokio 任务中执行,避免阻塞时间轮推进
批量操作优化:
small_batch_threshold):小批量直接处理,避免分组排序开销sort_unstable_by)提升性能SmallVec 优化:在批量取消中使用 smallvec 减少小型集合的堆分配
跨层迁移优化:
use kestrel_protocol_timer::{TimerWheel, WheelConfig};
use std::time::Duration;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
// 使用默认配置
// L0: 512 槽位,10ms tick,覆盖 5.12 秒
// L1: 64 槽位,1000ms tick,覆盖 64 秒
let timer = TimerWheel::with_defaults();
// 或使用自定义配置(分层时间轮)
let config = WheelConfig::builder()
.l0_tick_duration(Duration::from_millis(10)) // L0 tick 时长
.l0_slot_count(512) // L0 槽位数量
.l1_tick_duration(Duration::from_secs(1)) // L1 tick 时长
.l1_slot_count(64) // L1 槽位数量
.build()?;
let timer = TimerWheel::new(config);
Ok(())
}
use std::sync::Arc;
use std::sync::atomic::{AtomicU32, Ordering};
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let counter = Arc::new(AtomicU32::new(0));
let counter_clone = Arc::clone(&counter);
// 两步式 API:创建任务 + 注册
let callback = Some(CallbackWrapper::new(move || {
let counter = Arc::clone(&counter_clone);
async move {
counter.fetch_add(1, Ordering::SeqCst);
println!("定时器触发!");
}
}));
let task = TimerWheel::create_task(Duration::from_millis(100), callback);
let handle = timer.register(task);
// 等待定时器完成
handle.into_completion_receiver().0.await.ok();
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let callback = Some(CallbackWrapper::new(|| async {
println!("这条消息不会被打印");
}));
let task = TimerWheel::create_task(Duration::from_secs(10), callback);
let handle = timer.register(task);
// 取消定时器
let cancelled = handle.cancel();
println!("取消成功: {}", cancelled);
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let counter = Arc::new(AtomicU32::new(0));
let counter_clone = Arc::clone(&counter);
// 创建一个 50ms 后触发的定时器
let callback = Some(CallbackWrapper::new(move || {
let counter = Arc::clone(&counter_clone);
async move {
counter.fetch_add(1, Ordering::SeqCst);
println!("定时器触发!");
}
}));
let task = TimerWheel::create_task(Duration::from_millis(50), callback);
let task_id = task.get_id();
let handle = timer.register(task);
// 推迟到 150ms 后触发(保持原回调)
let postponed = timer.postpone(task_id, Duration::from_millis(150), None);
println!("推迟成功: {}", postponed);
// 等待定时器完成
handle.into_completion_receiver().0.await.ok();
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let callback = Some(CallbackWrapper::new(|| async {
println!("原始回调");
}));
let task = TimerWheel::create_task(Duration::from_millis(50), callback);
let task_id = task.get_id();
let handle = timer.register(task);
// 推迟并替换回调函数
let new_callback = Some(CallbackWrapper::new(|| async {
println!("新的回调!");
}));
let postponed = timer.postpone(task_id, Duration::from_millis(100), new_callback);
println!("推迟成功: {}", postponed);
// 等待定时器完成(会执行新回调)
handle.into_completion_receiver().0.await.ok();
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let counter = Arc::new(AtomicU32::new(0));
// 创建 100 个定时器回调
let callbacks: Vec<_> = (0..100)
.map(|i| {
let counter = Arc::clone(&counter);
let delay = Duration::from_millis(100 + i * 10);
let callback = Some(CallbackWrapper::new(move || {
let counter = Arc::clone(&counter);
async move {
counter.fetch_add(1, Ordering::SeqCst);
}
}));
(delay, callback)
})
.collect();
// 批量调度:创建任务 + 注册
let tasks = TimerWheel::create_batch_with_callbacks(callbacks);
let batch_handle = timer.register_batch(tasks);
println!("已调度 {} 个定时器", batch_handle.len());
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
// 创建批量定时器
let callbacks: Vec<_> = (0..50)
.map(|_| (Duration::from_secs(10), Some(CallbackWrapper::new(|| async {}))))
.collect();
let tasks = TimerWheel::create_batch_with_callbacks(callbacks);
let batch_handle = timer.register_batch(tasks);
// 批量取消
let cancelled_count = batch_handle.cancel_all();
println!("已取消 {} 个定时器", cancelled_count);
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let counter = Arc::new(AtomicU32::new(0));
// 创建 100 个定时器
let mut task_ids = Vec::new();
for _ in 0..100 {
let counter_clone = Arc::clone(&counter);
let callback = Some(CallbackWrapper::new(move || {
let counter = Arc::clone(&counter_clone);
async move {
counter.fetch_add(1, Ordering::SeqCst);
}
}));
let task = TimerWheel::create_task(Duration::from_millis(50), callback);
task_ids.push((task.get_id(), Duration::from_millis(150)));
timer.register(task);
}
// 批量推迟所有定时器
let postponed = timer.postpone_batch(task_ids);
println!("已推迟 {} 个定时器", postponed);
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let counter = Arc::new(AtomicU32::new(0));
// 创建批量定时器
let mut task_ids = Vec::new();
for _ in 0..50 {
let task = TimerWheel::create_task(Duration::from_millis(50), None);
task_ids.push(task.get_id());
timer.register(task);
}
// 批量推迟并替换回调
let updates: Vec<_> = task_ids
.into_iter()
.map(|id| {
let counter = Arc::clone(&counter);
let callback = Some(CallbackWrapper::new(move || {
let counter = Arc::clone(&counter);
async move {
counter.fetch_add(1, Ordering::SeqCst);
}
}));
(id, Duration::from_millis(150), callback)
})
.collect();
let postponed = timer.postpone_batch_with_callbacks(updates);
println!("已推迟 {} 个定时器并替换回调", postponed);
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let callback = Some(CallbackWrapper::new(|| async {
println!("定时器触发");
}));
let task = TimerWheel::create_task(Duration::from_millis(100), callback);
let handle = timer.register(task);
// 等待定时器完成
match handle.into_completion_receiver().0.await {
Ok(_) => println!("定时器已完成"),
Err(_) => println!("定时器被取消"),
}
use kestrel_protocol_timer::CallbackWrapper;
let timer = TimerWheel::with_defaults();
let counter = Arc::new(AtomicU32::new(0));
// 创建批量定时器
let callbacks: Vec<_> = (0..10)
.map(|i| {
let counter = Arc::clone(&counter);
let delay = Duration::from_millis(50 + i * 10);
let callback = Some(CallbackWrapper::new(move || {
let counter = Arc::clone(&counter);
async move {
counter.fetch_add(1, Ordering::SeqCst);
}
}));
(delay, callback)
})
.collect();
let tasks = TimerWheel::create_batch_with_callbacks(callbacks);
let batch_handle = timer.register_batch(tasks);
// 获取所有完成通知接收器
let receivers = batch_handle.into_completion_receivers();
// 等待所有定时器完成
for (i, rx) in receivers.into_iter().enumerate() {
rx.await.ok();
println!("定时器 {} 已完成", i);
}
println!("所有定时器已完成,共触发 {} 次", counter.load(Ordering::SeqCst));
use kestrel_protocol_timer::TimerTask;
let timer = TimerWheel::with_defaults();
// 创建仅发送通知的定时器(无回调函数)
let task = TimerTask::new(Duration::from_millis(100), None);
let handle = timer.register(task);
// 等待通知
handle.into_completion_receiver().0.await.ok();
println!("定时器到期");
TimerService 提供基于 Actor 模式的集中式定时器管理,适合需要统一处理大量定时器超时事件的场景。
use kestrel_protocol_timer::{TimerWheel, TimerService, CallbackWrapper, ServiceConfig};
let timer = TimerWheel::with_defaults();
let mut service = timer.create_service(ServiceConfig::default());
// 两步式 API:创建任务 + 注册
let callback = Some(CallbackWrapper::new(|| async {
println!("通过 service 调度的定时器触发");
}));
let task = TimerService::create_task(Duration::from_millis(100), callback);
let task_id = task.get_id();
service.register(task).unwrap();
println!("已调度任务 ID: {:?}", task_id);
use kestrel_protocol_timer::{CallbackWrapper, ServiceConfig};
let timer = TimerWheel::with_defaults();
let mut service = timer.create_service(ServiceConfig::default());
// 批量调度定时器:创建 + 注册
let callbacks: Vec<_> = (0..100)
.map(|_| (Duration::from_millis(100), Some(CallbackWrapper::new(|| async {}))))
.collect();
let tasks = TimerService::create_batch_with_callbacks(callbacks);
service.register_batch(tasks).unwrap();
println!("已调度 100 个任务");
// 获取超时通知接收器
let mut timeout_rx = service.take_receiver()
.expect("接收器只能被获取一次");
// 接收超时通知
let mut completed_count = 0;
while let Some(task_id) = timeout_rx.recv().await {
completed_count += 1;
println!("任务 {:?} 已完成", task_id);
if completed_count >= 100 {
break;
}
}
// 关闭 service
service.shutdown().await;
use kestrel_protocol_timer::{CallbackWrapper, ServiceConfig};
let timer = TimerWheel::with_defaults();
let service = timer.create_service(ServiceConfig);
// 通过 service 直接调度定时器
let callback1 = Some(CallbackWrapper::new(|| async {
println!("任务 1 触发");
}));
let task1 = TimerService::create_task(Duration::from_secs(5), callback1);
let task_id1 = task1.get_id();
service.register(task1).unwrap();
let callback2 = Some(CallbackWrapper::new(|| async {
println!("任务 2 触发");
}));
let task2 = TimerService::create_task(Duration::from_secs(10), callback2);
let task_id2 = task2.get_id();
service.register(task2).unwrap();
// 取消任务
let cancelled = service.cancel_task(task_id2);
println!("任务 2 取消结果: {}", cancelled);
// 批量取消
let task_ids = vec![task_id1];
let cancelled_count = service.cancel_batch(&task_ids);
println!("批量取消了 {} 个任务", cancelled_count);
use kestrel_protocol_timer::{CallbackWrapper, ServiceConfig};
let timer = TimerWheel::with_defaults();
let service = timer.create_service(ServiceConfig::default());
let counter = Arc::new(AtomicU32::new(0));
let counter_clone = Arc::clone(&counter);
// 调度一个任务
let callback = Some(CallbackWrapper::new(move || {
let counter = Arc::clone(&counter_clone);
async move {
counter.fetch_add(1, Ordering::SeqCst);
}
}));
let task = TimerService::create_task(Duration::from_millis(50), callback);
let task_id = task.get_id();
service.register(task).unwrap();
// 推迟任务(保持原回调)
let postponed = service.postpone(task_id, Duration::from_millis(150), None);
println!("推迟结果: {}", postponed);
// 接收超时通知
let mut rx = service.take_receiver().unwrap();
if let Some(completed_task_id) = rx.recv().await {
println!("任务 {:?} 已完成", completed_task_id);
}
// 批量推迟任务
let callbacks: Vec<_> = (0..10)
.map(|_| (Duration::from_millis(50), Some(CallbackWrapper::new(|| async {}))))
.collect();
let tasks = TimerService::create_batch_with_callbacks(callbacks);
let task_ids: Vec<_> = tasks.iter().map(|t| t.get_id()).collect();
service.register_batch(tasks).unwrap();
let updates: Vec<_> = task_ids
.iter()
.map(|&id| (id, Duration::from_millis(150)))
.collect();
let postponed_count = service.postpone_batch(updates);
println!("批量推迟了 {} 个任务", postponed_count);
TimerWheel::with_defaults() -> Self
使用默认配置创建定时器(分层时间轮):
let timer = TimerWheel::with_defaults();
TimerWheel::new(config: WheelConfig) -> Self
使用自定义配置创建定时器(分层时间轮)。
参数:
config:时间轮配置(通过 WheelConfigBuilder 构建并验证)配置项:
l0_tick_duration:L0 层 tick 时长l0_slot_count:L0 层槽位数量(必须是 2 的幂次方)l1_tick_duration:L1 层 tick 时长(必须是 L0 tick 的整数倍)l1_slot_count:L1 层槽位数量(必须是 2 的幂次方)let config = WheelConfig::builder()
.l0_tick_duration(Duration::from_millis(10))
.l0_slot_count(512)
.l1_tick_duration(Duration::from_secs(1))
.l1_slot_count(64)
.build()?;
let timer = TimerWheel::new(config);
fn create_task(delay: Duration, callback: Option<CallbackWrapper>) -> TimerTask(静态方法)
创建一个定时器任务(申请阶段)。
参数:
delay:延迟时间callback:可选的回调包装器(Option<CallbackWrapper>)返回:
TimerTask:待注册的定时器任务use kestrel_protocol_timer::CallbackWrapper;
let callback = Some(CallbackWrapper::new(|| async {
println!("1 秒后执行");
}));
let task = TimerWheel::create_task(Duration::from_secs(1), callback);
fn register(&self, task: TimerTask) -> TimerHandle
注册定时器任务到时间轮(注册阶段)。
参数:
task:通过 create_task() 创建的任务返回:
TimerHandle:定时器句柄use kestrel_protocol_timer::CallbackWrapper;
let callback = Some(CallbackWrapper::new(|| async {}));
let task = TimerWheel::create_task(Duration::from_secs(1), callback);
let handle = timer.register(task);
fn create_batch(delays: Vec<Duration>) -> Vec<TimerTask>(静态方法)
批量创建定时器任务(申请阶段,无回调)。
参数:
delays:延迟时间的向量返回:
Vec<TimerTask>:待注册的任务列表let delays = vec![Duration::from_secs(1), Duration::from_secs(2)];
let tasks = TimerWheel::create_batch(delays);
let batch = timer.register_batch(tasks);
fn create_batch_with_callbacks(callbacks: Vec<(Duration, Option<CallbackWrapper>)>) -> Vec<TimerTask>(静态方法)
批量创建定时器任务(申请阶段,带回调)。
参数:
callbacks:(延迟时间, 可选回调) 的向量返回:
Vec<TimerTask>:待注册的任务列表use kestrel_protocol_timer::CallbackWrapper;
let callbacks = vec![
(Duration::from_secs(1), Some(CallbackWrapper::new(|| async { println!("1"); }))),
(Duration::from_secs(2), Some(CallbackWrapper::new(|| async { println!("2"); }))),
];
let tasks = TimerWheel::create_batch_with_callbacks(callbacks);
let batch = timer.register_batch(tasks);
fn register_batch(&self, tasks: Vec<TimerTask>) -> BatchHandle
批量注册定时器任务到时间轮(注册阶段)。
参数:
tasks:通过 create_batch() 或 create_batch_with_callbacks() 创建的任务列表返回:
BatchHandle:批量句柄fn postpone(&self, task_id: TaskId, new_delay: Duration, callback: Option<CallbackWrapper>) -> bool
推迟定时器任务。
参数:
task_id:要推迟的任务 IDnew_delay:新的延迟时间(从当前时间点重新计算)callback:可选的新回调函数。如果为 None,则保持原回调;如果为 Some,则替换回调返回:
true:成功推迟false:任务不存在use kestrel_protocol_timer::CallbackWrapper;
// 推迟并保持原回调
let postponed = timer.postpone(task_id, Duration::from_secs(10), None);
// 推迟并替换回调
let new_callback = Some(CallbackWrapper::new(|| async {
println!("新回调");
}));
let postponed = timer.postpone(task_id, Duration::from_secs(10), new_callback);
fn postpone_batch(&self, updates: Vec<(TaskId, Duration)>) -> usize
批量推迟定时器任务(保持原回调)。
参数:
updates:(任务ID, 新延迟) 的向量返回:成功推迟的任务数量
let updates = vec![
(task_id1, Duration::from_secs(10)),
(task_id2, Duration::from_secs(15)),
];
let postponed = timer.postpone_batch(updates);
fn postpone_batch_with_callbacks(&self, updates: Vec<(TaskId, Duration, Option<CallbackWrapper>)>) -> usize
批量推迟定时器任务并可选择替换回调。
参数:
updates:(任务ID, 新延迟, 可选回调) 的向量返回:成功推迟的任务数量
use kestrel_protocol_timer::CallbackWrapper;
let updates = vec![
(task_id1, Duration::from_secs(10), Some(CallbackWrapper::new(|| async { println!("1"); }))),
(task_id2, Duration::from_secs(15), None), // 保持原回调
];
let postponed = timer.postpone_batch_with_callbacks(updates);
create_service(&self, server_config: ServiceConfig) -> TimerService
创建一个 TimerService 实例,用于集中管理定时器。
use kestrel_protocol_timer::ServiceConfig;
let service = timer.create_service(ServiceConfig::default());
cancel(&self) -> bool
取消定时器。
返回:
true:成功取消false:任务已不存在(可能已触发或被取消)let cancelled = handle.cancel();
task_id(&self) -> TaskId
获取任务 ID。
let id = handle.task_id();
into_completion_receiver(self) -> CompletionReceiver
消耗句柄,返回完成通知接收器。
let receiver = handle.into_completion_receiver();
receiver.0.await.ok();
len(&self) -> usize
获取批量句柄中的任务数量。
let count = batch.len();
cancel_all(&self) -> usize
取消所有定时器。
返回:成功取消的任务数量。
let cancelled = batch.cancel_all();
into_completion_receivers(self) -> Vec<CompletionReceiver>
消耗批量句柄,返回所有完成通知接收器。
let receivers = batch.into_completion_receivers();
for rx in receivers {
rx.await.ok();
}
fn create_task(delay: Duration, callback: Option<CallbackWrapper>) -> TimerTask(静态方法)
创建定时器任务(申请阶段)。
参数:
delay:延迟时间callback:可选的回调包装器返回:TimerTask
use kestrel_protocol_timer::CallbackWrapper;
let callback = Some(CallbackWrapper::new(|| async {}));
let task = TimerService::create_task(Duration::from_secs(1), callback);
fn create_batch(delays: Vec<Duration>) -> Vec<TimerTask>(静态方法)
批量创建定时器任务(申请阶段,无回调)。
返回:Vec<TimerTask>
let delays = vec![Duration::from_secs(1), Duration::from_secs(2)];
let tasks = TimerService::create_batch(delays);
fn create_batch_with_callbacks(callbacks: Vec<(Duration, Option<CallbackWrapper>)>) -> Vec<TimerTask>(静态方法)
批量创建定时器任务(申请阶段,带回调)。
返回:Vec<TimerTask>
use kestrel_protocol_timer::CallbackWrapper;
let callbacks = vec![
(Duration::from_secs(1), Some(CallbackWrapper::new(|| async {})))
];
let tasks = TimerService::create_batch_with_callbacks(callbacks);
fn register(&self, task: TimerTask) -> Result<(), TimerError>
注册定时器任务到服务(注册阶段)。
let task = TimerService::create_task(Duration::from_secs(1), || async {});
service.register(task).unwrap();
fn register_batch(&self, tasks: Vec<TimerTask>) -> Result<(), TimerError>
批量注册定时器任务到服务(注册阶段)。
let tasks = TimerService::create_batch_with_callbacks(callbacks);
service.register_batch(tasks).unwrap();
take_receiver(&mut self) -> Option<mpsc::Receiver<TaskId>>
获取超时通知接收器(只能调用一次)。
let mut rx = service.take_receiver().unwrap();
while let Some(task_id) = rx.recv().await {
println!("任务 {:?} 超时", task_id);
}
fn cancel_task(&self, task_id: TaskId) -> bool
取消指定的任务。
返回:是否成功取消
let cancelled = service.cancel_task(task_id);
fn cancel_batch(&self, task_ids: &[TaskId]) -> usize
批量取消任务。
返回:成功取消的任务数量
let cancelled_count = service.cancel_batch(&task_ids);
fn postpone(&self, task_id: TaskId, new_delay: Duration, callback: Option<CallbackWrapper>) -> bool
推迟任务。
参数:
task_id:要推迟的任务 IDnew_delay:新的延迟时间callback:可选的新回调函数。如果为 None,则保持原回调;如果为 Some,则替换回调返回:是否成功推迟
use kestrel_protocol_timer::CallbackWrapper;
// 推迟并保持原回调
let postponed = service.postpone(task_id, Duration::from_secs(10), None);
// 推迟并替换回调
let new_callback = Some(CallbackWrapper::new(|| async {
println!("新回调");
}));
let postponed = service.postpone(task_id, Duration::from_secs(10), new_callback);
fn postpone(&self, task_id: TaskId, new_delay: Duration, callback: Option<CallbackWrapper>) -> bool
fn postpone_batch(&self, updates: Vec<(TaskId, Duration)>) -> usize
批量推迟任务(保持原回调)。
返回:成功推迟的任务数量
let updates = vec![(task_id1, Duration::from_secs(10))];
let postponed = service.postpone_batch(updates);
fn postpone_batch_with_callbacks(&self, updates: Vec<(TaskId, Duration, Option<CallbackWrapper>)>) -> usize
批量推迟任务并可选择替换回调。
返回:成功推迟的任务数量
use kestrel_protocol_timer::CallbackWrapper;
let updates = vec![
(task_id1, Duration::from_secs(10), Some(CallbackWrapper::new(|| async { println!("1"); }))),
(task_id2, Duration::from_secs(15), None), // 保持原回调
];
let postponed = service.postpone_batch_with_callbacks(updates);
shutdown(self) -> ()
关闭服务。
service.shutdown().await;
分层时间轮采用双层架构,L0 层处理短延迟任务,L1 层处理长延迟任务。
槽位数量(l0_slot_count):
Tick 时长(l0_tick_duration):
覆盖范围:l0_slot_count × l0_tick_duration(默认:512 × 10ms = 5.12 秒)
槽位数量(l1_slot_count):
Tick 时长(l1_tick_duration):
覆盖范围:l1_slot_count × l1_tick_duration(默认:64 × 1s = 64 秒)
L1 tick / L0 tick = l1_tick_duration / l0_tick_duration
高精度、短延迟场景(网络超时):
let config = WheelConfig::builder()
.l0_tick_duration(Duration::from_millis(5)) // 5ms 精度
.l0_slot_count(1024) // 覆盖 5.12 秒
.l1_tick_duration(Duration::from_millis(500)) // 500ms
.l1_slot_count(64) // 覆盖 32 秒
.build()?;
let timer = TimerWheel::new(config);
一般场景(使用默认配置):
// L0: 512 槽位 × 10ms = 5.12 秒
// L1: 64 槽位 × 1s = 64 秒
// 总覆盖范围:64 秒(支持 rounds 可扩展)
let timer = TimerWheel::with_defaults();
低精度、长时间场景(心跳检测):
let config = WheelConfig::builder()
.l0_tick_duration(Duration::from_millis(100)) // 100ms 精度
.l0_slot_count(512) // 覆盖 51.2 秒
.l1_tick_duration(Duration::from_secs(10)) // 10 秒
.l1_slot_count(128) // 覆盖 1280 秒(21 分钟)
.build()?;
let timer = TimerWheel::new(config);
L0 层设计原则:
L1 层设计原则:
层级比率建议:
项目包含完整的性能基准测试,使用 Criterion 框架实现。
# 运行所有基准测试
cargo bench
# 运行特定基准测试
cargo bench --bench service_benchmark
cargo bench --bench wheel_benchmark
测试单个定时器的调度性能。
cargo bench schedule_single
典型结果:单次调度耗时约 5-10 微秒
测试批量调度不同规模定时器的性能。
cargo bench schedule_batch
测试规模:10、100、1000 个定时器
典型结果:
批量操作明显比单个操作更高效。
测试单个和批量取消的性能。
cargo bench cancel_single
cargo bench cancel_batch
典型结果:
测试单个和批量推迟的性能。
cargo bench postpone_single
cargo bench postpone_batch
典型结果:
测试多线程并发调度的性能。
cargo bench concurrent_schedule
测试时间轮推进操作的性能。
cargo bench wheel_advance
与基于堆(BinaryHeap)的传统定时器实现相比:
| 操作 | 分层时间轮 | 堆实现 | 优势 |
|---|---|---|---|
| 插入单个任务 | O(1) ~5μs | O(log n) ~10-20μs | 2-4x 更快 |
| 批量插入 1000 | O(1000) ~2ms | O(1000 log n) ~15-25ms | 7-12x 更快 |
| 取消任务 | O(1) ~2μs | O(n) ~50-100μs | 25-50x 更快 |
| 推迟任务 | O(1) ~4μs | O(log n) ~15-30μs | 4-7x 更快 |
| 触发到期任务 | O(k) | O(k log n) | 更稳定 |
| 时间轮推进 | O(1)* | O(log n) | 更高效 |
注:
| 指标 | 分层时间轮 | 单层时间轮 | 改进 |
|---|---|---|---|
| 短延迟任务推进 | 无 rounds 检查 | 需要 rounds 检查 | ~20% 更快 |
| 长延迟任务存储 | L1 层稀疏存储 | 全部在 L0 层 | ~30% 内存节省 |
| 覆盖范围 | 0-64 秒高效 | 0-5.12 秒高效 | 12x 扩展 |
| CPU 占用 | L1 每 100 tick 推进 | 每 tick 都检查所有槽位 | 更低 |
集成测试包含大规模场景测试:
cargo test --test integration_test test_large_scale_timers
测试场景:
# 运行所有测试
cargo test
# 运行单元测试
cargo test --lib
# 运行集成测试
cargo test --test integration_test
# 运行特定测试
cargo test test_basic_timer
项目包含完整的测试套件:
use std::time::Duration;
use kestrel_protocol_timer::CallbackWrapper;
// 为每个网络连接设置超时
async fn handle_connection(timer: &TimerWheel, conn_id: u64) {
let callback = Some(CallbackWrapper::new(move || async move {
println!("连接 {} 超时,关闭连接", conn_id);
// 关闭连接逻辑
}));
let task = TimerWheel::create_task(Duration::from_secs(30), callback);
let task_id = task.get_id();
let timeout_handle = timer.register(task);
// 如果收到部分数据,延长超时时间(保持原回调)
// timer.postpone(task_id, Duration::from_secs(30), None);
// 如果连接完成,取消超时
// timeout_handle.cancel();
}
use kestrel_protocol_timer::CallbackWrapper;
// 延迟 5 秒执行清理任务
let callback = Some(CallbackWrapper::new(|| async {
cleanup_temporary_files().await;
}));
let task = TimerWheel::create_task(Duration::from_secs(5), callback);
timer.register(task);
use kestrel_protocol_timer::{CallbackWrapper, ServiceConfig};
let config = WheelConfig::builder()
.l0_tick_duration(Duration::from_millis(100)) // 100ms 精度足够心跳检测
.l0_slot_count(512) // 覆盖 51.2 秒
.l1_tick_duration(Duration::from_secs(10)) // 10 秒
.l1_slot_count(128) // 覆盖 21 分钟
.build()?;
let timer = TimerWheel::new(config);
let mut service = timer.create_service(ServiceConfig::default());
// 为每个客户端设置心跳检测
for client_id in client_ids {
let callback = Some(CallbackWrapper::new(move || async move {
println!("客户端 {} 心跳超时", client_id);
disconnect_client(client_id).await;
}));
let task = TimerService::create_task(Duration::from_secs(30), callback);
service.register(task).unwrap();
}
// 统一处理超时
let mut rx = service.take_receiver().unwrap();
while let Some(task_id) = rx.recv().await {
println!("心跳检测超时: {:?}", task_id);
}
use std::collections::HashMap;
use std::sync::Arc;
use parking_lot::Mutex;
use kestrel_protocol_timer::CallbackWrapper;
struct CacheManager {
timer: TimerWheel,
cache: Arc<Mutex<HashMap<String, String>>>,
}
impl CacheManager {
async fn set(&self, key: String, value: String, ttl: Duration) {
// 存储到缓存
self.cache.lock().insert(key.clone(), value);
// 设置过期定时器
let cache = Arc::clone(&self.cache);
let callback = Some(CallbackWrapper::new(move || {
let cache = Arc::clone(&cache);
let key = key.clone();
async move {
cache.lock().remove(&key);
println!("缓存键 {} 已过期", key);
}
}));
let task = TimerWheel::create_task(ttl, callback);
self.timer.register(task);
}
}
use kestrel_protocol_timer::CallbackWrapper;
// 每个任务在特定时间后执行
let tasks = vec![
("任务A", Duration::from_secs(10)),
("任务B", Duration::from_secs(30)),
("任务C", Duration::from_secs(60)),
];
let callbacks: Vec<_> = tasks.into_iter()
.map(|(name, delay)| {
let callback = Some(CallbackWrapper::new(move || async move {
println!("执行定时任务: {}", name);
execute_scheduled_task(name).await;
}));
(delay, callback)
})
.collect();
let task_list = TimerWheel::create_batch_with_callbacks(callbacks);
timer.register_batch(task_list);
use kestrel_protocol_timer::CallbackWrapper;
// 游戏角色的 buff 效果管理
async fn apply_buff(
timer: &TimerWheel,
player_id: u64,
buff_type: BuffType,
duration: Duration
) -> TaskId {
println!("玩家 {} 获得 buff: {:?}", player_id, buff_type);
let callback = Some(CallbackWrapper::new(move || async move {
println!("玩家 {} 的 buff {:?} 已失效", player_id, buff_type);
remove_buff(player_id, buff_type).await;
}));
let task = TimerWheel::create_task(duration, callback);
let task_id = task.get_id();
timer.register(task);
task_id
}
// 延长 buff 持续时间
async fn extend_buff(
timer: &TimerWheel,
task_id: TaskId,
extra_duration: Duration
) {
// 保持原回调
let extended = timer.postpone(task_id, extra_duration, None);
if extended {
println!("Buff 持续时间已延长");
}
}
use kestrel_protocol_timer::CallbackWrapper;
// 实现带退避策略的重试机制
async fn retry_with_backoff(
timer: &TimerWheel,
service: &TimerService,
operation: impl Fn() -> BoxFuture<'static, Result<(), Error>>
) {
let mut retry_count = 0;
let max_retries = 5;
loop {
match operation().await {
Ok(_) => break,
Err(e) if retry_count < max_retries => {
retry_count += 1;
// 指数退避:1s, 2s, 4s, 8s, 16s
let delay = Duration::from_secs(2_u64.pow(retry_count - 1));
println!("操作失败,{} 秒后重试(第 {} 次)", delay.as_secs(), retry_count);
let callback = Some(CallbackWrapper::new(move || async move {
println!("开始第 {} 次重试", retry_count);
}));
let task = TimerService::create_task(delay, callback);
service.register(task).unwrap();
// 等待定时器触发...
}
Err(e) => {
println!("达到最大重试次数,操作失败: {:?}", e);
break;
}
}
}
}
| 依赖 | 版本 | 用途 |
|---|---|---|
| tokio | 1.48+ | 异步运行时,提供异步任务调度和执行 |
| parking_lot | 0.12 | 高性能锁实现,比标准库 Mutex 更快 |
| rustc-hash | 2.1 | FxHashMap 实现,减少哈希冲突 |
| futures | 0.3 | 异步工具和抽象 |
| smallvec | 1.15 | 小型向量优化,减少堆分配 |
| 依赖 | 版本 | 用途 |
|---|---|---|
| criterion | 0.7 | 性能基准测试框架 |
欢迎贡献代码、报告问题或提出建议!
如果您发现 bug 或有功能请求,请在 GitHub 上创建 issue,包含:
git checkout -b feature/my-featurecargo testcargo clippycargo fmtgit commit -am 'Add my feature'git push origin feature/my-featurecargo fmt 格式化代码cargo clippy 检查代码质量# 克隆仓库
git clone https://github.com/ShaoG-R/kestrel-protocol-timer.git
cd kestrel-protocol-timer
# 运行测试
cargo test
# 运行基准测试
cargo bench
# 检查代码
cargo clippy
# 格式化代码
cargo fmt
本项目采用 MIT 或 Apache-2.0 双许可证。
您可以选择以下任一许可证使用本项目:
时间轮算法最早由 George Varghese 和 Tony Lauck 在论文 "Hashed and Hierarchical Timing Wheels: Data Structures for the Efficient Implementation of a Timer Facility" (SOSP '87) 中提出。
如有问题或建议,欢迎提交 issue 或 PR!