2026-03-18 17:49:22 +08:00
|
|
|
# ILogSink
|
|
|
|
|
|
|
|
|
|
**命名空间**: `XCEngine::Debug`
|
|
|
|
|
|
|
|
|
|
**类型**: `class` (abstract interface)
|
|
|
|
|
|
2026-03-20 02:35:07 +08:00
|
|
|
**头文件**: `XCEngine/Debug/ILogSink.h`
|
|
|
|
|
|
2026-03-18 17:49:22 +08:00
|
|
|
**描述**: 日志输出槽抽象接口,定义日志输出的标准协议。
|
|
|
|
|
|
|
|
|
|
## 概述
|
|
|
|
|
|
|
|
|
|
`ILogSink` 是日志系统的输出抽象接口。用户可以实现此接口来创建自定义的日志输出方式,如网络输出、数据库存储等。`Logger` 通过多个 Sink 分发日志。
|
|
|
|
|
|
|
|
|
|
## 公共方法
|
|
|
|
|
|
|
|
|
|
| 方法 | 描述 |
|
|
|
|
|
|------|------|
|
2026-03-20 02:35:07 +08:00
|
|
|
| [`Log`](log.md) | 输出单条日志 |
|
|
|
|
|
| [`Flush`](flush.md) | 刷新缓冲区,确保日志写入 |
|
2026-03-18 17:49:22 +08:00
|
|
|
|
|
|
|
|
## 使用示例
|
|
|
|
|
|
|
|
|
|
```cpp
|
|
|
|
|
class CustomLogSink : public ILogSink {
|
|
|
|
|
public:
|
|
|
|
|
void Log(const LogEntry& entry) override {
|
|
|
|
|
printf("[%s] %s: %s\n",
|
|
|
|
|
LogLevelToString(entry.level),
|
|
|
|
|
LogCategoryToString(entry.category),
|
|
|
|
|
entry.message.CStr());
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void Flush() override {
|
|
|
|
|
fflush(stdout);
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
Logger::Get().AddSink(std::make_unique<CustomLogSink>());
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## 相关文档
|
|
|
|
|
|
docs: 重构 API 文档结构并修正源码准确性
- 重组文档目录结构: 每个模块的概述页移动到模块子目录
- 重命名 index.md 为 main.md
- 修正所有模块文档中的错误:
- math: FromEuler→FromEulerAngles, TransformDirection 包含缩放, Box 是 OBB, Color::ToRGBA 格式
- containers: 新增 operator==/!= 文档, 补充 std::hash DJB 算法细节
- core: 修复 types 链接错误
- debug: LogLevelToString 返回大写, timestamp 是秒, Profiler 空实现标注, Windows API vs ANSI
- memory: 修复头文件路径, malloc vs operator new, 新增方法文档
- resources: 修复 Shader/Texture 链接错误
- threading: TaskSystem::Wait 空实现标注, ReadWriteLock 重入描述, LambdaTask 链接
- 验证: fix_links.py 确认 0 个断裂引用
2026-03-19 00:22:30 +08:00
|
|
|
- [Debug 模块总览](../debug.md) - 返回模块总览
|
|
|
|
|
- [Logger](../logger/logger.md) - 日志记录器
|
|
|
|
|
- [ConsoleLogSink](../consolelogsink/consolelogsink.md) - 控制台输出
|
|
|
|
|
- [FileLogSink](../filelogsink/filelogsink.md) - 文件输出
|