HPSocket.Net 项目启动与配置教程

HPSocket.Net 项目启动与配置教程

HPSocket.Net the C# SDK for HP-Socket https://github.com/ldcsaa/HP-Socket 项目地址: https://gitcode.com/gh_mirrors/hp/HPSocket.Net

1. 项目目录结构及介绍

HPSocket.Net 是一个基于 .NET 的 HP-Socket 封装库，它支持多种网络通信协议。项目的目录结构如下：

HPSocket.Net/
├── demo/                    # 示例代码目录
├── src/                     # 源代码目录
│   ├── HPSocket.Net/        # 核心库代码
│   ├── Models/              # 模型类目录
│   └── Adapter/             # 数据接收适配器目录
├── .gitignore               # Git 忽略文件
├── LICENSE                  # 开源协议文件
├── README.md                # 项目说明文件
└── README_zh.md             # 项目说明文件（中文）

demo/ 目录

包含了一些示例项目，用于展示如何使用 HPSocket.Net 库来实现不同的网络通信功能。

src/ 目录

包含了项目的所有源代码，包括核心库代码、模型类以及数据接收适配器。

.gitignore 文件

指定了 Git 应该忽略的文件和目录列表，以避免将不必要的文件提交到版本控制中。

LICENSE 文件

包含了项目的开源协议，本项目采用 Apache-2.0 协议。

README.md 和 README_zh.md 文件

这两个文件都是项目说明文件，分别提供了英文和中文的项目介绍、安装指南和使用说明。

2. 项目的启动文件介绍

HPSocket.Net 项目的启动主要是通过 demo 目录下的示例项目来完成的。以下是一个简单的 TCP 服务器示例：

// TcpServer-TestEcho.cs
using HPSocket;
using System;

class Program
{
    static void Main(string[] args)
    {
        using (ITcpServer server = new TcpServer())
        {
            // 配置服务器
            server.SetLocalAddress("0.0.0.0");
            server.SetLocalPort(12345);
            server.OnPrepareListen += (sender, e) =>
            {
                Console.WriteLine("准备监听...");
            };

            server.OnAccept += (sender, e) =>
            {
                Console.WriteLine("客户端已连接：{0}", e.Socket.ToString());
            };

            server.OnHandShake += (sender, e) =>
            {
                Console.WriteLine("握手成功：{0}", e.Socket.ToString());
            };

            server.OnReceive += (sender, e) =>
            {
                Console.WriteLine("收到数据：{0}", Encoding.UTF8.GetString(e.Data));
            };

            server.OnClose += (sender, e) =>
            {
                Console.WriteLine("连接已关闭：{0}", e.Socket.ToString());
            };

            // 启动服务器
            server.Start();
            Console.WriteLine("服务器启动成功，等待客户端连接...");

            // 等待用户输入，按任意键退出
            Console.ReadKey();
        }
    }
}

这个示例创建了一个 TCP 服务器，监听 0.0.0.0 地址的 12345 端口，并在控制台输出相关的网络事件信息。

3. 项目的配置文件介绍

HPSocket.Net 项目的配置主要通过代码进行设置。在上面的示例中，我们通过调用 SetLocalAddress 和 SetLocalPort 方法来配置服务器的监听地址和端口。HPSocket.Net 支持的配置选项很多，以下是一些常见的配置：

• SetLocalAddress：设置监听地址。
• SetLocalPort：设置监听端口。
• SetTimeOut：设置超时时间。
• SetMaxConnection：设置最大连接数。
• SetSendBufferSize：设置发送缓冲区大小。
• SetReceiveBufferSize：设置接收缓冲区大小。

对于更复杂的配置，如代理设置、SSL 配置等，可以在创建服务器、客户端或代理实例时进行设置，或者通过事件处理函数来实现更细致的控制。

HPSocket.Net the C# SDK for HP-Socket https://github.com/ldcsaa/HP-Socket 项目地址: https://gitcode.com/gh_mirrors/hp/HPSocket.Net