netman 开源项目教程

netman 开源项目教程

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

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

netman 项目的目录结构如下：

netman/
├── common/
├── eventloop/
├── examples/
├── iface/
├── server/
├── util/
├── .gitignore
├── LICENSE
├── README.md
├── c1000k.md
├── go.mod
├── go.sum

目录介绍

• common/: 包含项目中常用的公共代码和工具函数。
• eventloop/: 事件循环相关的代码，用于处理网络事件。
• examples/: 包含项目的示例代码，展示了如何使用 netman 框架。
• iface/: 接口定义文件，定义了项目中使用的各种接口。
• server/: 服务器核心代码，包含了 TCP、UDP、WebSocket 等服务的实现。
• util/: 工具类代码，提供了一些常用的工具函数。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档。
• c1000k.md: 百万连接测试的文档。
• go.mod: Go 模块文件，定义了项目的依赖。
• go.sum: Go 模块的校验文件。

2. 项目的启动文件介绍

netman 项目的启动文件主要位于 server/ 目录下。以下是主要的启动文件及其功能介绍：

server/server.go

这是 netman 框架的核心启动文件，包含了服务器的初始化和启动逻辑。主要功能如下：

• New(): 创建一个新的服务器实例，并进行初始化配置。
• Start(): 启动服务器，开始监听网络连接。
• AddRouter(): 添加路由处理函数，用于处理不同类型的消息。

server/tcp_server.go

该文件包含了 TCP 服务器的实现，主要功能如下：

• NewTCPServer(): 创建一个新的 TCP 服务器实例。
• Start(): 启动 TCP 服务器，开始监听 TCP 连接。

server/udp_server.go

该文件包含了 UDP 服务器的实现，主要功能如下：

• NewUDPServer(): 创建一个新的 UDP 服务器实例。
• Start(): 启动 UDP 服务器，开始监听 UDP 连接。

server/websocket_server.go

该文件包含了 WebSocket 服务器的实现，主要功能如下：

• NewWebsocketServer(): 创建一个新的 WebSocket 服务器实例。
• Start(): 启动 WebSocket 服务器，开始监听 WebSocket 连接。

3. 项目的配置文件介绍

netman 项目的配置主要通过代码中的配置选项进行设置，没有独立的配置文件。以下是主要的配置选项及其功能介绍：

服务器配置

• WithMaxBodyLength(): 设置消息包体的最大长度。
• WithHooks(): 设置钩子函数，用于在连接打开和关闭时执行特定操作。
• WithPacker(): 设置自定义的封包解包规则。
• WithTLSConfig(): 配置 TLS 加密，用于开启 HTTPS 或 WSS 服务。
• WithHeartbeatIdleTime(): 设置心跳检测的空闲时间，超过该时间未活动的连接将被关闭。
• WithHeartbeatCheckInterval(): 设置心跳检测的间隔时间，定期检查连接的活动状态。

其他配置

• WithTCPKeepAlive(): 设置 TCP KeepAlive 时间，用于保持连接的活跃状态。
• WithLogOutput(): 设置日志输出的目标，如标准输出或文件。

通过这些配置选项，可以在启动服务器时灵活地调整服务器的各项参数，以满足不同的业务需求。

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