パッケージ jakarta.websocket
このパッケージには、クライアント側とサーバー側の両方に共通のすべての Jakarta WebSocket API が含まれています。
インターフェースのサマリー インターフェース 説明 ClientEndpointConfig ClientEndpointConfig は、クライアントエンドポイントのみに固有の Web ソケット構成情報を含む特別な種類のエンドポイント構成オブジェクトです。CloseReason.CloseCode 閉じるコードのマーカーインターフェース。Decoder Decoder インターフェースは、開発者が Web ソケットコンテナーに開発者が定義したカスタムオブジェクトへの Web ソケットメッセージを提供する方法を定義するメンバーインターフェースを保持します。Decoder.Binary<T> このインターフェースは、（型 T の）カスタムオブジェクトがバイトバッファの形式で Web ソケットメッセージからデコードされる方法を定義します。Decoder.BinaryStream<T> このインターフェースは、バイナリストリームの形式で Web ソケットメッセージからカスタムオブジェクトをデコードする方法を定義します。Decoder.Text<T> このインターフェースは、カスタムオブジェクトを文字列形式の Web ソケットメッセージからデコードする方法を定義します。Decoder.TextStream<T> このインターフェースは、型 T のカスタムオブジェクトが Web ソケットメッセージから文字ストリームの形式でデコードされる方法を定義します。Encoder Encoder インターフェースは、開発者がカスタムオブジェクトを Web ソケットメッセージに変換する方法を提供する方法を定義します。Encoder.Binary<T> このインターフェースは、カスタムオブジェクトをバイナリメッセージに変換する方法を提供する方法を定義します。Encoder.BinaryStream<T> このインターフェースは、エンコードされたオブジェクトをバイナリストリームに書き込むエンコードアルゴリズムによって実装できます。Encoder.Text<T> このインターフェースは、カスタムオブジェクトをテキストメッセージに変換する方法を提供する方法を定義します。Encoder.TextStream<T> このインターフェースは、エンコードされたオブジェクトを文字ストリームに書き込むエンコードアルゴリズムによって実装できます。EndpointConfig エンドポイント構成には、このエンドポイントのハンドシェイクプロセス中に必要なすべての情報が含まれています。Extension 拡張パラメーターの名前とマップとしての websocket 拡張の単純な表現。Extension.Parameter このメンバーインターフェースは、単一の websocket 拡張パラメーターを定義します。HandshakeResponse ハンドシェイクレスポンスは、開始ハンドシェイクリクエストへのレスポンスである WebSocket 定義の HTTP レスポンスを表します。MessageHandler 開発者は、Web ソケット会話中に受信メッセージを受信するために MessageHandlers を実装しています。MessageHandler.Partial<T> この種のハンドラーは、メッセージ全体の一部を配信する準備ができると、実装によって通知されます。MessageHandler.Whole<T> この種類のハンドラーは、完全なメッセージの到着時にコンテナーによって通知されます。PongMessage PongMessage インターフェースは、Web ソケットピンポンを表します。RemoteEndpoint RemoteEndpoint オブジェクトはコンテナーによって提供され、Web ソケット会話の「相手側」またはピアを表します。RemoteEndpoint.Async Web ソケット会話のピアのこの表現には、メッセージを非同期的に送信する機能があります。RemoteEndpoint.Basic Web ソケット会話のピアのこの表現には、メッセージを同期的に送信する機能があります。SendHandler Web ソケットメッセージの非同期送信用のシンプルなコールバックオブジェクト。Session Web ソケットセッションは、2 つの Web ソケットエンドポイント間の会話を表します。WebSocketContainer WebSocketContainer は、それを実行しているコンテナーのビューをアプリケーションに提供する実装提供オブジェクトです。クラスのサマリー クラス 説明 ClientEndpointConfig.Builder ClientEndpointConfig.Builder は、クライアントエンドポイントをデプロイする目的でClientEndpointConfigオブジェクトを作成するために使用されるクラスです。ClientEndpointConfig.Configurator Configurator クラスは、オープニングハンドシェイクのインターセプト、またはこのコンフィギュレーターで構成された各エンドポイントインスタンスからアクセスできる任意のメソッドとアルゴリズムを提供するなど、カスタム構成アルゴリズムを提供する開発者によって拡張できます。CloseReason Web ソケットが閉じられた理由、または閉じるように求められている理由をカプセル化するクラス。ContainerProvider 開発者が WebSocketContainer の実装への参照を取得できるようにするプロバイダークラス。Endpoint Web ソケットエンドポイントは、Websocket の会話を処理できるオブジェクトを表します。SendResult Web ソケットメッセージを非同期的に送信した結果。列挙型のサマリー 列挙型 説明 CloseReason.CloseCodes 仕様で定義されている Web ソケットクローズのステータスコードの列挙。例外のサマリー 例外 説明 DecodeException テキストまたはバイナリメッセージからカスタムオブジェクトをデコードしようとしたときに発生する一般的な例外。DeploymentException サーバー上でエンドポイントを公開するか、クライアントをサーバーに接続することのいずれかの失敗を示すチェック例外。EncodeException カスタムオブジェクトを文字列またはバイナリメッセージにエンコードしようとしたときに発生する一般的な例外。SessionException SessionException は、Websocket セッションで発生する問題を報告する一般的な例外型を表します。アノテーション型のサマリー アノテーション型 説明 ClientEndpoint ClientEndpoint アノテーションクラスレベルアノテーションは、POJO が Web ソケットクライアントであり、そのようにデプロイできることを示すために使用されます。OnClose このメソッドレベルのアノテーションは、Web ソケットセッションが閉じているときに呼び出される Java メソッドを修飾するために使用できます。OnError このメソッドレベルのアノテーションを使用して、エラーを処理するために呼び出す Java メソッドを修飾できます。OnMessage このメソッドレベルのアノテーションを使用して、Java メソッドに受信 Web ソケットメッセージを受信させることができます。OnOpen このメソッドレベルのアノテーションを使用して、新しい Web ソケットセッションが開いているときに呼び出される Java メソッドを修飾できます。