TsgcWebSocketClient 是围绕 sgcWebSockets 运行时客户端的 .NET 包装器。它继承了 TsgcWebSocketClient_base 的所有核心 WebSocket 功能,为 .NET 应用程序提供了一个组件风格的 API,用于通过 WebSocket 进行连接、发送和接收。
关键属性
- Host 和 Port – 目标服务器端点
- Options.Parameters – WebSocket 握手的 URL 路径或查询参数
- TLS 和 TLSOptions – 启用 TLS 并选择协议版本/IO 处理程序
- Specifications.RFC6455 – 切换 RFC6455 WebSocket 帧合规性
- Proxy – HTTP 代理配置(Enabled、Username、Password、Host、Port)
- Extensions.PerMessage_Deflate.Enabled – 启用逐消息压缩
- Authentication – 需要时的基本身份验证凭据
- Active – 设置为
true连接,false断开连接
事件
注册事件处理程序以响应连接生命周期和数据:
- OnConnect – 连接成功后触发;示例处理程序记录对等方 IP
- OnDisconnect – 连接关闭时触发,提供关闭代码
- OnMessage – 接收来自服务器的文本消息
- OnError – 报告协议或套接字错误
- OnException – 暴露组件内部引发的意外异常
示例
using esegece.sgcWebSockets;
var client = new TsgcWebSocketClient();
client.OnConnect += OnConnectEvent;
client.OnDisconnect += OnDisconnectEvent;
client.OnException += OnExceptionEvent;
client.OnError += OnErrorEvent;
client.OnMessage += OnMessageEvent;
client.Host = "www.esegece.com";
client.Port = 2052;
client.Options.Parameters = "/";
client.TLS = false;
client.Specifications.RFC6455 = true;
client.Active = true;
// Sending data once connected
client.WriteData("Hello WebSocket!");
此代码片段与演示用法一致:在连接前注册事件,配置关键属性(主机、端口、TLS、RFC6455 等),并将 Active 设置为 true 以启动连接。
定义好事件处理程序后(如上所示),客户端可以记录连接、接收消息并通过 WriteData 发送数据。
