ngtcp2 项目教程

1. 项目的目录结构及介绍

ngtcp2/
├── examples/
│   ├── client.cc
│   ├── server.cc
│   └── ...
├── lib/
│   ├── ngtcp2.h
│   ├── ngtcp2_conn.c
│   └── ...
├── src/
│   ├── main.c
│   └── ...
├── tests/
│   ├── test_conn.c
│   └── ...
├── CMakeLists.txt
├── README.md
└── ...

目录结构介绍

• examples/: 包含项目的示例代码，如客户端 (client.cc) 和服务器 (server.cc)。
• lib/: 包含项目的核心库文件，如 ngtcp2.h 和 ngtcp2_conn.c。
• src/: 包含项目的主要源代码文件，如 main.c。
• tests/: 包含项目的测试代码，如 test_conn.c。
• CMakeLists.txt: 项目的构建配置文件。
• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

启动文件：src/main.c

src/main.c 是项目的主要启动文件。它包含了项目的入口函数 main()，负责初始化项目并启动主要的逻辑流程。

#include "ngtcp2.h"

int main(int argc, char *argv[]) {
    // 初始化 ngtcp2 连接
    ngtcp2_conn *conn = ngtcp2_conn_new();
    
    // 启动服务器或客户端逻辑
    if (is_server) {
        start_server(conn);
    } else {
        start_client(conn);
    }
    
    // 清理资源
    ngtcp2_conn_free(conn);
    return 0;
}

启动流程

1. 初始化连接：使用 ngtcp2_conn_new() 初始化一个新的 ngtcp2_conn 对象。
2. 启动逻辑：根据配置启动服务器 (start_server()) 或客户端 (start_client()) 逻辑。
3. 清理资源：使用 ngtcp2_conn_free() 释放连接对象。

3. 项目的配置文件介绍

配置文件：CMakeLists.txt

CMakeLists.txt 是项目的构建配置文件，用于配置项目的编译和构建过程。

cmake_minimum_required(VERSION 3.10)
project(ngtcp2)

set(CMAKE_CXX_STANDARD 20)

# 添加源文件
add_executable(ngtcp2 src/main.c lib/ngtcp2_conn.c)

# 添加库文件
target_link_libraries(ngtcp2 PRIVATE ngtcp2)

# 添加测试
enable_testing()
add_test(NAME test_conn COMMAND tests/test_conn)

配置文件内容

• 项目设置：设置项目名称和所需的 CMake 版本。
• 编译标准：设置 C++ 标准为 C++20。
• 源文件：添加主要的源文件 (src/main.c 和 lib/ngtcp2_conn.c)。
• 库文件：链接 ngtcp2 库。
• 测试：启用测试并添加测试文件 (tests/test_conn)。

通过以上配置，项目可以正确编译和构建，并包含必要的测试和库文件。