TsgcWebSocketClient › 事件

TsgcWebSocketClient 事件

可处理的事件按用途分组，后跟完整的字母顺序列表。

生命周期

名称	描述
OnConnect	当与服务器的 WebSocket 连接成功建立时触发。
OnDisconnect	当 WebSocket 连接断开或关闭时触发。
OnError	每次连接上发生 WebSocket 协议错误时触发。
OnHandshake	当客户端 HTTP 握手正在构建时触发，以便添加自定义头部。
OnException	每当处理连接时发生未处理的异常，就会触发。
OnBeforeHeartBeat	在每次心跳 ping 之前触发，以便应用程序发送自定义保活消息。
OnBeforeWatchDog	在每次 WatchDog 重连尝试之前触发，以便应用程序调整目标服务器或抑制重试。
OnBeforeConnect	在客户端尝试连接服务器之前触发。

数据

名称	描述
OnMessage	每次服务器向客户端发送文本消息时触发。
OnBinary	每次服务器向客户端发送二进制消息时触发。
OnFragmented	当 Options.FragmentedMessages 为 frgAll 或 frgOnlyFragmented 时，每接收到一个分片就触发一次。

可靠性

名称	描述
OnLoadBalancerError	当 LoadBalancer 启用且与负载均衡服务器通信出现错误时触发。

安全性

名称	描述
OnSSLGetHandler	在创建 SSL 处理程序之前触发，允许提供自定义处理程序实例。
OnSSLAfterCreateHandler	在 SSL 处理器创建后触发，以便自定义其属性。
OnSSLVerifyPeer	当 VerifyCertificate 已启用时触发，以便应用程序可以接受或拒绝服务器证书。
OnSChannelVerifyPeer	当 SChannel 作为 TLS IOHandler 时触发，以便应用程序可以验证服务器证书。

所有事件（按字母顺序排列）

名称	描述
OnBeforeConnect	在客户端尝试连接服务器之前触发。
OnBeforeHeartBeat	在每次心跳 ping 之前触发，以便应用程序发送自定义保活消息。
OnBeforeWatchDog	在每次 WatchDog 重连尝试之前触发，以便应用程序调整目标服务器或抑制重试。
OnBinary	每次服务器向客户端发送二进制消息时触发。
OnConnect	当与服务器的 WebSocket 连接成功建立时触发。
OnDisconnect	当 WebSocket 连接断开或关闭时触发。
OnError	每次连接上发生 WebSocket 协议错误时触发。
OnException	每当处理连接时发生未处理的异常，就会触发。
OnFragmented	当 Options.FragmentedMessages 为 frgAll 或 frgOnlyFragmented 时，每接收到一个分片就触发一次。
OnHandshake	当客户端 HTTP 握手正在构建时触发，以便添加自定义头部。
OnLoadBalancerError	当 LoadBalancer 启用且与负载均衡服务器通信出现错误时触发。
OnMessage	每次服务器向客户端发送文本消息时触发。
OnSChannelVerifyPeer	当 SChannel 作为 TLS IOHandler 时触发，以便应用程序可以验证服务器证书。
OnSSLAfterCreateHandler	在 SSL 处理器创建后触发，以便自定义其属性。
OnSSLGetHandler	在创建 SSL 处理程序之前触发，允许提供自定义处理程序实例。
OnSSLVerifyPeer	当 VerifyCertificate 已启用时触发，以便应用程序可以接受或拒绝服务器证书。