Netman 开源项目使用教程

Netman 开源项目使用教程

netman高性能轻量级TCP、UDP框架、支持TLS、路由、中间件、WebSocket、事件循环(epoll)，百万连接（C1000K）项目地址:https://gitcode.com/gh_mirrors/ne/netman

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

netman/
├── src/
│   ├── core/
│   ├── middleware/
│   ├── router/
│   ├── tls/
│   ├── websocket/
│   └── main.c
├── include/
│   ├── core.h
│   ├── middleware.h
│   ├── router.h
│   ├── tls.h
│   └── websocket.h
├── config/
│   └── netman.conf
├── docs/
│   └── README.md
├── LICENSE
└── README.md

目录结构介绍

• src/: 包含项目的源代码文件，分为多个子目录：

  • core/: 核心功能模块。
  • middleware/: 中间件模块。
  • router/: 路由模块。
  • tls/: TLS 加密模块。
  • websocket/: WebSocket 模块。
  • main.c: 项目的启动文件。

• include/: 包含项目的头文件，每个模块对应一个头文件。

• config/: 包含项目的配置文件 netman.conf。

• docs/: 包含项目的文档文件，如 README.md。

• LICENSE: 项目的开源许可证文件。

• README.md: 项目的介绍文件。

2. 项目的启动文件介绍

src/main.c

main.c 是项目的启动文件，负责初始化项目的各个模块并启动服务。以下是 main.c 的主要功能：

• 初始化配置: 读取 config/netman.conf 文件中的配置信息。
• 初始化核心模块: 初始化核心功能模块，如事件循环（epoll）。
• 加载中间件: 加载并初始化中间件模块。
• 设置路由: 设置并初始化路由模块。
• 启动服务: 启动 TCP/UDP 服务，支持 TLS 和 WebSocket。

3. 项目的配置文件介绍

config/netman.conf

netman.conf 是项目的配置文件，用于配置项目的各项参数。以下是配置文件的主要内容：

[server]
port = 8080
host = 0.0.0.0

[tls]
enable = true
cert_file = /path/to/cert.pem
key_file = /path/to/key.pem

[websocket]
enable = true
path = /ws

[middleware]
enable = true

配置项介绍

• [server]: 服务器配置

  • port: 服务器监听的端口号。
  • host: 服务器监听的 IP 地址。

• [tls]: TLS 配置

  • enable: 是否启用 TLS 加密。
  • cert_file: TLS 证书文件路径。
  • key_file: TLS 私钥文件路径。

• [websocket]: WebSocket 配置

  • enable: 是否启用 WebSocket 支持。
  • path: WebSocket 路径。

• [middleware]: 中间件配置

  • enable: 是否启用中间件。

通过以上配置文件，可以灵活地调整项目的运行参数，以适应不同的应用场景。

netman高性能轻量级TCP、UDP框架、支持TLS、路由、中间件、WebSocket、事件循环(epoll)，百万连接（C1000K）项目地址:https://gitcode.com/gh_mirrors/ne/netman