TsgcWebSocketServer › 事件

TsgcWebSocketServer 事件

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

生命周期

名称描述
OnStartup服务器启动并准备好接受连接后触发。
OnShutdown服务器停止后且不再接受连接时触发。
OnTCPConnect在客户端在 TCP 层连接之后、WebSocket 握手之前触发,因此可以接受或拒绝连接。
OnConnect每次与客户端建立 WebSocket 连接时触发。
OnDisconnect每次与客户端的 WebSocket 连接断开时触发。
OnHandshake在服务器端对握手进行评估后、发送响应之前触发。
OnError每当发生 WebSocket 协议错误(如格式错误的握手)时触发。
OnException当处理客户端连接时引发未处理的异常,则触发此事件。
OnUnknownProtocol当第一条消息不匹配已知协议时触发,可以接受或拒绝连接。
OnUnknownAuthentication当启用身份验证但无法识别身份验证方法时触发。

数据

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

可靠性

名称描述
OnBeforeHeartBeat在每次 HeartBeat ping 之前触发,以便应用程序实现自定义保活逻辑。
OnLoadBalancerConnect当服务器连接到负载均衡服务器时触发。
OnLoadBalancerDisconnect当服务器从负载均衡器服务器断开连接时触发。
OnLoadBalancerError当与负载均衡器服务器通信发生错误时触发。

安全性

名称描述
OnAuthentication当启用身份验证时触发,以便应用程序可以检查用户名和密码。
OnSSLGetHandler在创建 SSL 处理程序之前触发,允许提供自定义处理程序实例。
OnSSLAfterCreateHandler在 SSL 处理器创建后触发,以便自定义其属性。
OnSSLALPNSelect在启用 ALPN 的握手期间触发,以便应用程序可以选择协商哪个协议。
OnSSLVerifyPeer当启用 VerifyCertificate 且客户端提交证书待接受或拒绝时触发。

所有事件(按字母顺序排列)

名称描述
OnAuthentication当启用身份验证时触发,以便应用程序可以检查用户名和密码。
OnBeforeHeartBeat在每次 HeartBeat ping 之前触发,以便应用程序实现自定义保活逻辑。
OnBinary每次客户端发送二进制消息且服务器收到时触发。
OnConnect每次与客户端建立 WebSocket 连接时触发。
OnDisconnect每次与客户端的 WebSocket 连接断开时触发。
OnError每当发生 WebSocket 协议错误(如格式错误的握手)时触发。
OnException当处理客户端连接时引发未处理的异常,则触发此事件。
OnFragmented当接收到消息的分片时触发(仅当 Options.FragmentedMessages 为 frgAll 或 frgOnlyFragmented 时)。
OnHandshake在服务器端对握手进行评估后、发送响应之前触发。
OnLoadBalancerConnect当服务器连接到负载均衡服务器时触发。
OnLoadBalancerDisconnect当服务器从负载均衡器服务器断开连接时触发。
OnLoadBalancerError当与负载均衡器服务器通信发生错误时触发。
OnMessage每次客户端发送文本消息且服务器接收到时触发。
OnShutdown服务器停止后且不再接受连接时触发。
OnSSLAfterCreateHandler在 SSL 处理器创建后触发,以便自定义其属性。
OnSSLALPNSelect在启用 ALPN 的握手期间触发,以便应用程序可以选择协商哪个协议。
OnSSLGetHandler在创建 SSL 处理程序之前触发,允许提供自定义处理程序实例。
OnSSLVerifyPeer当启用 VerifyCertificate 且客户端提交证书待接受或拒绝时触发。
OnStartup服务器启动并准备好接受连接后触发。
OnTCPConnect在客户端在 TCP 层连接之后、WebSocket 握手之前触发,因此可以接受或拒绝连接。
OnUnknownAuthentication当启用身份验证但无法识别身份验证方法时触发。
OnUnknownProtocol当第一条消息不匹配已知协议时触发,可以接受或拒绝连接。