TsgcWebSocketServer_HTTPAPI › 事件

TsgcWebSocketServer_HTTPAPI 事件

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

生命周期

名称	描述
OnStartup	HTTP API 服务器启动并准备好接受连接后触发。
OnShutdown	HTTP API 服务器停止且不再接受请求后触发。
OnBeforeBinding	在服务器绑定到已配置 URL 之前触发，以便检查或自定义绑定列表。
OnTCPConnect	在客户端在 TCP 层连接之后、WebSocket 握手之前触发，因此可以接受或拒绝连接。
OnConnect	每次与客户端建立 WebSocket 连接时触发。
OnDisconnect	每次与客户端的 WebSocket 连接断开时触发。
OnHandshake	在服务器端对握手进行评估后、发送响应之前触发。
OnError	每当发生 WebSocket 协议错误（如格式错误的握手）时触发。
OnException	当处理客户端连接时引发未处理的异常，则触发此事件。
OnUnknownProtocol	HTTP API 服务器目前不支持此功能；此声明是为了与 TsgcWebSocketServer 保持 API 兼容。

数据

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

HTTP

名称	描述
OnHTTPRequest	当服务器收到 HTTP 请求时触发，以便应用程序可以构建响应。
OnBeforeForwardHTTP	在调度 HTTP 请求之前触发，以便将其转发（反向代理）到另一台 HTTP 服务器。
OnAfterForwardHTTP	在 HTTP 请求转发后触发，以便应用程序可以检查结果或上游服务器返回的错误。

HTTP 上传

名称	描述
OnHTTPUploadBeforeSaveFile	在从 multipart/form-data 上传中提取的文件保存到磁盘之前触发，以便自定义文件名和路径。
OnHTTPUploadAfterSaveFile	当从 multipart/form-data 上传中提取的文件已保存到磁盘后触发。
OnHTTPUploadReadInput	当 multipart/form-data 解码器读取非文件输入字段时触发，以便捕获其值。
OnHTTPUploadBeforeCreatePostStream	在读取请求头并在创建 POST 流之前触发，以便接受或拒绝上传。

可靠性

名称	描述
OnBeforeHeartBeat	在每次 HeartBeat ping 之前触发，以便应用程序实现自定义保活逻辑。
OnAsynchronous	当 HTTP API 服务器发起的异步发送操作完成时触发。

安全性

名称	描述
OnAuthentication	当启用身份验证时触发，以便应用程序检查用户名和密码并接受或拒绝连接。

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

名称	描述
OnAfterForwardHTTP	在 HTTP 请求转发后触发，以便应用程序可以检查结果或上游服务器返回的错误。
OnAsynchronous	当 HTTP API 服务器发起的异步发送操作完成时触发。
OnAuthentication	当启用身份验证时触发，以便应用程序检查用户名和密码并接受或拒绝连接。
OnBeforeBinding	在服务器绑定到已配置 URL 之前触发，以便检查或自定义绑定列表。
OnBeforeForwardHTTP	在调度 HTTP 请求之前触发，以便将其转发（反向代理）到另一台 HTTP 服务器。
OnBeforeHeartBeat	在每次 HeartBeat ping 之前触发，以便应用程序实现自定义保活逻辑。
OnBinary	每次客户端发送二进制消息且服务器收到时触发。
OnConnect	每次与客户端建立 WebSocket 连接时触发。
OnDisconnect	每次与客户端的 WebSocket 连接断开时触发。
OnError	每当发生 WebSocket 协议错误（如格式错误的握手）时触发。
OnException	当处理客户端连接时引发未处理的异常，则触发此事件。
OnFragmented	当接收到消息的分片时触发（仅当 Options.FragmentedMessages 为 frgAll 或 frgOnlyFragmented 时）。
OnHandshake	在服务器端对握手进行评估后、发送响应之前触发。
OnHTTPRequest	当服务器收到 HTTP 请求时触发，以便应用程序可以构建响应。
OnHTTPUploadAfterSaveFile	当从 multipart/form-data 上传中提取的文件已保存到磁盘后触发。
OnHTTPUploadBeforeCreatePostStream	在读取请求头并在创建 POST 流之前触发，以便接受或拒绝上传。
OnHTTPUploadBeforeSaveFile	在从 multipart/form-data 上传中提取的文件保存到磁盘之前触发，以便自定义文件名和路径。
OnHTTPUploadReadInput	当 multipart/form-data 解码器读取非文件输入字段时触发，以便捕获其值。
OnMessage	每次客户端发送文本消息且服务器接收到时触发。
OnShutdown	HTTP API 服务器停止且不再接受请求后触发。
OnStartup	HTTP API 服务器启动并准备好接受连接后触发。
OnTCPConnect	在客户端在 TCP 层连接之后、WebSocket 握手之前触发，因此可以接受或拒绝连接。
OnUnknownProtocol	HTTP API 服务器目前不支持此功能；此声明是为了与 TsgcWebSocketServer 保持 API 兼容。