Files
XCEngine/docs/api/XCEngine/Debug/FileLogSink/Flush.md

38 lines
746 B
Markdown
Raw Normal View History

2026-03-26 16:45:24 +08:00
# FileLogSink::Flush
2026-03-26 17:21:44 +08:00
把底层文件缓冲区刷新到磁盘。
2026-03-26 16:45:24 +08:00
```cpp
void Flush() override;
```
2026-03-26 17:21:44 +08:00
## 行为说明
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
当前实现直接转发到 `Core::FileWriter::Flush()`。如果文件尚未成功打开,`FileWriter` 会返回 `false`,但 `FileLogSink::Flush` 本身不会上报错误。
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
需要注意的是,当前 `FileLogSink::Log` 在每次写入后已经主动调用一次 `Flush`,因此手动调用更多是为了表达语义,而不是补齐缺失步骤。
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
## 参数
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
- 无。
## 返回值
- 无。
## 线程语义
2026-03-26 16:45:24 +08:00
2026-03-26 17:21:44 +08:00
- 通过 `Logger` 使用时通常是串行的。
## 示例
```cpp
XCEngine::Debug::FileLogSink sink("engine.log");
sink.Flush();
2026-03-26 16:45:24 +08:00
```
## 相关文档
2026-03-26 17:21:44 +08:00
- [返回类型总览](FileLogSink.md)
- [Log](Log.md)