WatsonTcp 项目使用教程

WatsonTcp 项目使用教程

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

WatsonTcp 项目的目录结构如下：

WatsonTcp/
├── assets/
├── src/
├── .gitignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── DONATIONS.md
├── FRAMING.md
├── LICENSE.md
├── README.md
├── TestDebug.bat
├── TestDebugStream.bat

目录介绍

• assets/: 存放项目相关的资源文件。
• src/: 存放项目的源代码文件。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• DONATIONS.md: 捐赠信息。
• FRAMING.md: 消息帧结构参考文档。
• LICENSE.md: 项目许可证。
• README.md: 项目介绍和使用说明。
• TestDebug.bat: 调试测试脚本。
• TestDebugStream.bat: 流调试测试脚本。

2. 项目的启动文件介绍

WatsonTcp 项目的启动文件位于 src/ 目录下，主要包含以下文件：

• WatsonTcp.cs: 核心库文件，包含客户端和服务器的实现。
• Program.cs: 主程序入口文件，用于启动服务器或客户端实例。

启动文件介绍

• WatsonTcp.cs: 该文件定义了 WatsonTcp 的核心功能，包括客户端和服务器的连接管理、消息处理等。
• Program.cs: 该文件包含了程序的入口点，通过命令行参数来决定启动服务器还是客户端，并进行相应的配置和初始化。

3. 项目的配置文件介绍

WatsonTcp 项目的配置文件主要是通过代码进行配置，没有独立的配置文件。以下是一些常见的配置项：

配置项介绍

• Keepalive 配置:

  server.Keepalive.EnableTcpKeepAlives = true;
  server.Keepalive.TcpKeepAliveInterval = 5; // 秒
  server.Keepalive.TcpKeepAliveTime = 5; // 秒
  server.Keepalive.TcpKeepAliveRetryCount = 5; // 次
  

• TLS 配置:

  server.Settings.AcceptInvalidCertificates = true; // 接受无效证书
  

• IP 地址和端口配置:

  server.Start("127.0.0.1", 8000); // 启动服务器，监听本地 8000 端口
  

通过以上配置项，可以灵活地配置 WatsonTcp 服务器和客户端的行为。

---

以上是 WatsonTcp 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 WatsonTcp 项目。