模块文档索引

模块文档索引
C++ 后端服务器框架模块文档索引
CHAPTER 02

模块文档索引

2 分钟阅读 · 359 字

以下文档按你指定的模块拆分，每个模块独立描述头文件接口与 src 具体实现：

  1. docs/modules/Channel.md
  2. docs/modules/Coroutine.md
  3. docs/modules/Crash.md
  4. docs/modules/DBConnector.md
  5. docs/modules/EmailSender.md
  6. docs/modules/JsonObjectView.md
  7. docs/modules/JWT.md
  8. docs/modules/RDConnector.md
  9. docs/modules/Server.md
  10. docs/modules/Threadpool.md
  11. docs/modules/YamlParser.md

函数级参考手册（超细粒度，逐模块追加）

  • docs/modules/detail/Channel_FUNCTIONS.md — Channel<T> 模板：push / pop / close / 运算符
  • docs/modules/detail/Coroutine_FUNCTIONS.md — Coroutine / Scheduler / yield / safe_point 等逐函数说明
  • docs/modules/detail/Crash_FUNCTIONS.md — CrashHandler / 信号与 SEH / gracefulExit / SAFE_ASSERT
  • docs/modules/detail/DBConnector_FUNCTIONS.md — 单例生命周期 / connect / query / execute / SQL 转义
  • docs/modules/detail/EmailSender_FUNCTIONS.md — SMTP 连接 / AUTH LOGIN / sendMail 流程
  • docs/modules/detail/JsonObjectView_FUNCTIONS.md — parse / operator[] / asString / asInt / asNumber / 导出 map
  • docs/modules/detail/JWT_FUNCTIONS.md — token 生成校验 / claims 解析 / 密码哈希与验证
  • docs/modules/detail/RDConnector_FUNCTIONS.md — Redis connect/get/set/setex/exists/del 与单例语义
  • docs/modules/detail/Server_FUNCTIONS.md — 主链路函数级拆解（线程池版本 vs 协程版本）

阅读建议（面试）

  • 先看 Server（主链路）
  • 再看 Threadpool + Coroutine（并发）
  • 再看 DBConnector + RDConnector + JWT（基础设施）
  • 最后看 Crash + YamlParser + EmailSender + Channel + JsonObjectView（工程化能力）

统一说明

  • 文档依据的接口文件：
    • include/Channel.h
    • include/Coroutine.h
    • include/Crash.h
    • include/DBConnector.h
    • include/EmailSender.h
    • include/JsonObjectView.h
    • include/jwt.h
    • include/RDConnector.h
    • include/Server.h
    • include/Threadpool.h
    • include/YamlParser.h
  • 文档依据的实现文件：
    • src/Channel.cpp
    • src/Coroutine.cpp
    • src/Crash.cpp
    • src/DBConnector.cpp
    • src/EmailSender.cpp
    • src/jwt.cpp
    • src/RDConnector.cpp
    • src/Server.cpp
    • src/Threadpool.cpp
全部章节