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 互換性のために宣言されています。