From 0c86f9aad8e3687bbd7b67539b1968214c984bf3 Mon Sep 17 00:00:00 2001 From: Zedhugh Chen Date: Mon, 13 Apr 2026 05:37:31 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20backend=5Fnext=5Fevent=20=E6=8E=A5?= =?UTF-8?q?=E5=8F=A3=E6=B7=BB=E5=8A=A0=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/core/backend.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/src/core/backend.h b/src/core/backend.h index e46f09d..cfdec89 100644 --- a/src/core/backend.h +++ b/src/core/backend.h @@ -18,4 +18,16 @@ void backend_destroy(backend_t *backend); backend_detect_t *backend_detect(backend_t *backend); void backend_detect_destroy(backend_detect_t *detect); +/** + * @brief 阻塞等待 backend 产出下一个可交给 runtime 的归一化事件 + * @details + * backend 可以在内部丢弃无关的原始平台事件，直到拿到一个可路由事件或遇到 + * stop/error 条件。 + * + * 返回 true 时，`event` 已被完整填充；若其中包含堆内存，所有权转交给调用方， + * 调用方必须在本轮处理结束后调用 event_cleanup() 或 event_reset()。 + * + * 返回 false 时，表示 backend 请求停止或遇到错误；此时 `event` 必须保持为 + * 无需 cleanup 的状态，调用方可以直接退出循环。 + */ bool backend_next_event(backend_t *backend, event_t *event);