docs: update core and debug API docs
This commit is contained in:
@@ -9,6 +9,8 @@ FileLogSink(const Containers::String& filePath)
|
||||
**参数:**
|
||||
- `filePath` - 日志文件路径
|
||||
|
||||
**线程安全:** ✅ 构造函数本身是线程安全的,但多线程同时创建同一文件可能会产生竞争
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
@@ -16,10 +16,10 @@
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| `FileLogSink(const Containers::String& filePath)` | [构造函数](construct.md) |
|
||||
| `~FileLogSink()` | [析构函数](~filelogsink.md) |
|
||||
| `void Log(const LogEntry& entry)` | [输出日志到文件](log.md) |
|
||||
| `void Flush()` | [刷新缓冲区](flush.md) |
|
||||
| [`FileLogSink(const Containers::String& filePath)`](construct.md) | 打开指定路径的文件用于日志写入 |
|
||||
| [`~FileLogSink()`](~filelogsink.md) | 销毁实例并刷新缓冲区 |
|
||||
| [`Log(const LogEntry& entry)`](log.md) | 将日志条目追加写入文件 |
|
||||
| [`Flush()`](flush.md) | 刷新文件缓冲区确保数据写入磁盘 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
|
||||
@@ -6,19 +6,22 @@ void Flush() override
|
||||
|
||||
刷新文件缓冲区,调用底层 `FileWriter` 的 flush 方法确保所有待写入的日志数据已实际写入磁盘。
|
||||
|
||||
**线程安全:** ✅ 线程安全
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
**示例:**
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Debug/FileLogSink.h>
|
||||
|
||||
auto fileSink = std::make_unique<XCEngine::Debug::FileLogSink>("logs/app.log");
|
||||
XCEngine::Debug::Logger::Get().AddSink(std::move(fileSink));
|
||||
// 关键操作后立即刷新
|
||||
XCEngine::Debug::Logger::Get().Info(XCEngine::Debug::LogCategory::General, "Checkpoint saved");
|
||||
// 确保写入磁盘
|
||||
XCEngine::Debug::Logger::Get().Flush();
|
||||
// 关键操作后立即刷新确保写入磁盘
|
||||
fileSink->Flush();
|
||||
```
|
||||
|
||||
**注意:** `Flush()` 需要直接调用 `FileLogSink` 实例,不能通过 `Logger` 调用。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [FileLogSink 总览](filelogsink.md) - 返回类总览
|
||||
|
||||
@@ -9,6 +9,8 @@ void Log(const LogEntry& entry) override
|
||||
**参数:**
|
||||
- `entry` - 日志条目
|
||||
|
||||
**线程安全:** ❌ 非线程安全,多线程同时调用 Log 可能导致数据竞争
|
||||
|
||||
**复杂度:** O(m),m 为消息长度
|
||||
|
||||
**示例:**
|
||||
|
||||
@@ -6,6 +6,10 @@
|
||||
|
||||
析构函数。销毁 `FileLogSink` 实例,调用 `Flush()` 确保所有日志数据写入文件,然后关闭文件句柄。
|
||||
|
||||
**返回:** 无
|
||||
|
||||
**线程安全:** ✅ 析构函数是线程安全的
|
||||
|
||||
**复杂度:** O(1)
|
||||
|
||||
## 相关文档
|
||||
|
||||
Reference in New Issue
Block a user