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認証が有効になっており、アプリケーションがユーザーとパスワードを確認できるようにするために発生します。
OnSSLGetHandlerSSL ハンドラーが作成される前に発火し、カスタムハンドラーインスタンスを提供できます。
OnSSLAfterCreateHandlerSSL ハンドラーが作成された後に発火し、そのプロパティをカスタマイズできます。
OnSSLALPNSelectALPN対応のハンドシェイク中に発生し、アプリケーションがネゴシエートするプロトコルを選択できるようにします。
OnSSLVerifyPeerVerifyCertificate が有効になっており、クライアントが受け入れまたは拒否される証明書を提示したときに発生します。

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

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