TsgcWebSocketProxyServer › イベント

TsgcWebSocketProxyServer イベント

処理可能なイベントを目的別にグループ化し、その後完全なアルファベット順リストを表示します。

ライフサイクル

名前説明
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各HeartBeatピングの前に発生し、アプリケーションがダウンストリームWebSocketクライアント用のカスタムキープアライブを実装できます。
OnLoadBalancerConnectプロキシサーバーがロードバランサーサーバーに接続したときに発生します。
OnLoadBalancerDisconnectプロキシサーバーがLoad Balancer Serverから切断したときに発生します。
OnLoadBalancerErrorロードバランサーサーバーとの通信でエラーが発生したときに発火します。

セキュリティ

名前説明
OnAuthentication認証が有効になっているときに発生し、アプリケーションがユーザーとパスワードを確認してダウンストリームクライアント接続を承認または拒否できます。
OnSSLGetHandlerSSL ハンドラーが作成される前に発生し、カスタムのサーバーサイドハンドラーインスタンスを提供できます。
OnSSLAfterCreateHandlerSSL ハンドラーが作成された後に発火し、そのプロパティをカスタマイズできます。
OnSSLALPNSelectダウンストリームクライアントとの ALPN 対応ハンドシェイク中に発火し、アプリケーションがネゴシエートするプロトコルを選択できます。
OnSSLVerifyPeerVerifyCertificateが有効で、下流のクライアントが受け入れまたは拒否される証明書を提示したときに発生します。

すべてのイベント (アルファベット順)

名前説明
OnAuthentication認証が有効になっているときに発生し、アプリケーションがユーザーとパスワードを確認してダウンストリームクライアント接続を承認または拒否できます。
OnBeforeHeartBeat各HeartBeatピングの前に発生し、アプリケーションがダウンストリームWebSocketクライアント用のカスタムキープアライブを実装できます。
OnBinaryダウンストリームの WebSocket クライアントがバイナリメッセージを送信するたびに、プロキシがアップストリームに転送する前に発火します。
OnConnectダウンストリームクライアントとのWebSocket接続が確立され、プロキシがアップストリームTCPセッションを開くたびに発生します。
OnDisconnectダウンストリームクライアントとのWebSocket接続が切断され、アップストリームTCPセッションが閉じられるたびに発生します。
OnErrorプロキシが処理するダウンストリームクライアント接続で WebSocket プロトコルエラーが発生するたびに発火します。
OnExceptionダウンストリーム接続またはそのアップストリーム転送の処理中に、未処理の例外が発生したときに発生します。
OnFragmentedダウンストリームクライアントからメッセージのフラグメントを受信したときに発生します(Options.FragmentedMessages が frgAll または frgOnlyFragmented の場合のみ)。
OnHandshakeダウンストリームクライアントとのハンドシェイクが評価された後、レスポンスが送信される前に発生します。
OnLoadBalancerConnectプロキシサーバーがロードバランサーサーバーに接続したときに発生します。
OnLoadBalancerDisconnectプロキシサーバーがLoad Balancer Serverから切断したときに発生します。
OnLoadBalancerErrorロードバランサーサーバーとの通信でエラーが発生したときに発火します。
OnMessageプロキシがアップストリームに転送する前に、ダウンストリームの WebSocket クライアントがテキストメッセージを送信するたびに発火します。
OnShutdownプロキシサーバーが停止し、接続が受け入れられなくなった後に発生します。
OnSSLAfterCreateHandlerSSL ハンドラーが作成された後に発火し、そのプロパティをカスタマイズできます。
OnSSLALPNSelectダウンストリームクライアントとの ALPN 対応ハンドシェイク中に発火し、アプリケーションがネゴシエートするプロトコルを選択できます。
OnSSLGetHandlerSSL ハンドラーが作成される前に発生し、カスタムのサーバーサイドハンドラーインスタンスを提供できます。
OnSSLVerifyPeerVerifyCertificateが有効で、下流のクライアントが受け入れまたは拒否される証明書を提示したときに発生します。
OnStartupプロキシサーバーが起動し、接続を受け付ける準備ができた後に発生します。
OnTCPConnectダウンストリームクライアントが TCP レベルで接続し、WebSocket ハンドシェイクの前に発生します。接続を受け入れるか拒否できます。
OnUnknownAuthentication認証が有効でダウンストリームクライアントの認証メソッドがサーバーに認識されない場合に発生します。
OnUnknownProtocolダウンストリームクライアントからの最初のメッセージが既知のプロトコルと一致しない場合に発生し、接続を受け入れるか拒否するかを決定できます。