可处理的事件按用途分组,后跟完整的字母顺序列表。
| 名称 | 描述 |
|---|---|
| OnStartup | 代理服务器启动并准备好接受连接后触发。 |
| OnShutdown | 代理服务器停止且不再接受连接后触发。 |
| OnTCPConnect | 在下游客户端在 TCP 层连接且 WebSocket 握手之前触发,可在此接受或拒绝连接。 |
| OnConnect | 每当与下游客户端建立 WebSocket 连接且代理打开上游 TCP 会话时触发。 |
| OnDisconnect | 每当与下游客户端的 WebSocket 连接断开且上游 TCP 会话关闭时触发。 |
| OnHandshake | 在评估下游客户端握手之后、发送响应之前触发。 |
| OnError | 每当代理处理的下游客户端连接上发生 WebSocket 协议错误时触发。 |
| OnException | 每当处理下游连接或其上游转发时发生未处理异常时触发。 |
| OnUnknownProtocol | 当下游客户端的第一条消息不匹配任何已知协议时触发,可接受或拒绝该连接。 |
| OnUnknownAuthentication | 当启用认证且下游客户端的认证方式无法被服务器识别时触发。 |
| 名称 | 描述 |
|---|---|
| OnMessage | 每当下游 WebSocket 客户端发送文本消息且代理将其转发给上游之前触发。 |
| OnBinary | 每次下游 WebSocket 客户端发送二进制消息时、代理将其转发至上游之前触发。 |
| OnFragmented | 从下游客户端收到消息片段时触发(仅当 Options.FragmentedMessages 为 frgAll 或 frgOnlyFragmented 时)。 |
| 名称 | 描述 |
|---|---|
| OnBeforeHeartBeat | 在每次心跳 ping 之前触发,以便应用程序为下游 WebSocket 客户端实现自定义保活。 |
| OnLoadBalancerConnect | 当代理服务器连接到负载均衡服务器时触发。 |
| OnLoadBalancerDisconnect | 当代理服务器从负载均衡器服务器断开连接时触发。 |
| OnLoadBalancerError | 当与负载均衡器服务器通信发生错误时触发。 |
| 名称 | 描述 |
|---|---|
| OnAuthentication | 启用认证时触发,应用程序可在此检查用户名和密码,并决定接受或拒绝下游客户端连接。 |
| OnSSLGetHandler | 在创建 SSL 处理程序之前触发,以便提供自定义服务器端处理程序实例。 |
| OnSSLAfterCreateHandler | 在 SSL 处理器创建后触发,以便自定义其属性。 |
| OnSSLALPNSelect | 在与下游客户端进行启用了 ALPN 的握手期间触发,允许应用程序选择要协商的协议。 |
| OnSSLVerifyPeer | 当 VerifyCertificate 启用且下游客户端提供证书以供接受或拒绝时触发。 |
| 名称 | 描述 |
|---|---|
| OnAuthentication | 启用认证时触发,应用程序可在此检查用户名和密码,并决定接受或拒绝下游客户端连接。 |
| OnBeforeHeartBeat | 在每次心跳 ping 之前触发,以便应用程序为下游 WebSocket 客户端实现自定义保活。 |
| OnBinary | 每次下游 WebSocket 客户端发送二进制消息时、代理将其转发至上游之前触发。 |
| OnConnect | 每当与下游客户端建立 WebSocket 连接且代理打开上游 TCP 会话时触发。 |
| OnDisconnect | 每当与下游客户端的 WebSocket 连接断开且上游 TCP 会话关闭时触发。 |
| OnError | 每当代理处理的下游客户端连接上发生 WebSocket 协议错误时触发。 |
| OnException | 每当处理下游连接或其上游转发时发生未处理异常时触发。 |
| OnFragmented | 从下游客户端收到消息片段时触发(仅当 Options.FragmentedMessages 为 frgAll 或 frgOnlyFragmented 时)。 |
| OnHandshake | 在评估下游客户端握手之后、发送响应之前触发。 |
| OnLoadBalancerConnect | 当代理服务器连接到负载均衡服务器时触发。 |
| OnLoadBalancerDisconnect | 当代理服务器从负载均衡器服务器断开连接时触发。 |
| OnLoadBalancerError | 当与负载均衡器服务器通信发生错误时触发。 |
| OnMessage | 每当下游 WebSocket 客户端发送文本消息且代理将其转发给上游之前触发。 |
| OnShutdown | 代理服务器停止且不再接受连接后触发。 |
| OnSSLAfterCreateHandler | 在 SSL 处理器创建后触发,以便自定义其属性。 |
| OnSSLALPNSelect | 在与下游客户端进行启用了 ALPN 的握手期间触发,允许应用程序选择要协商的协议。 |
| OnSSLGetHandler | 在创建 SSL 处理程序之前触发,以便提供自定义服务器端处理程序实例。 |
| OnSSLVerifyPeer | 当 VerifyCertificate 启用且下游客户端提供证书以供接受或拒绝时触发。 |
| OnStartup | 代理服务器启动并准备好接受连接后触发。 |
| OnTCPConnect | 在下游客户端在 TCP 层连接且 WebSocket 握手之前触发,可在此接受或拒绝连接。 |
| OnUnknownAuthentication | 当启用认证且下游客户端的认证方式无法被服务器识别时触发。 |
| OnUnknownProtocol | 当下游客户端的第一条消息不匹配任何已知协议时触发,可接受或拒绝该连接。 |