パッケージ jakarta.websocket

インターフェース Encoder

  • すべての既知のサブインターフェース:
    Encoder.Binary<T>、Encoder.BinaryStream<T>、Encoder.Text<T>、Encoder.TextStream<T>
    public interface Encoder
    エンコーダーインターフェースは、開発者がカスタムオブジェクトを Web ソケットメッセージに変換する方法を提供する方法を定義します。エンコーダーインターフェースには、テキスト、バイナリデータ、文字ストリーム、出力ストリームへの書き込みにカスタムオブジェクトをエンコードするアルゴリズムを許可するサブインターフェースが含まれています。websocket 実装は、接続ごとのエンドポイントインスタンスごとにエンコーダーの新しいインスタンスを作成します。つまり、各エンコーダーインスタンスには、一度に最大で 1 つの呼び出しスレッドがあります。Encoder インスタンスのライフサイクルは、init(jakarta.websocket.EndpointConfig) および destroy() メソッドへのコンテナー呼び出しによって制御されます。
    作成者:
    dannycoward

    • ネストされたクラスのサマリー

      ネストされたクラス  
      修飾子と型 インターフェース 説明
      static interface Encoder.Binary<T>
      このインターフェースは、カスタムオブジェクトをバイナリメッセージに変換する方法を提供する方法を定義します。
      static interface Encoder.BinaryStream<T>
      このインターフェースは、エンコードされたオブジェクトをバイナリストリームに書き込むエンコードアルゴリズムによって実装できます。
      static interface Encoder.Text<T>
      このインターフェースは、カスタムオブジェクトをテキストメッセージに変換する方法を提供する方法を定義します。
      static interface Encoder.TextStream<T>
      このインターフェースは、エンコードされたオブジェクトを文字ストリームに書き込むエンコードアルゴリズムによって実装できます。

    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   デフォルトメソッド  
      修飾子と型 メソッド 説明
      default voiddestroy()
      このメソッドは、エンコーダーがサービスから削除されようとしているときに呼び出され、エンコーダーが使用したリソースを適切に閉じることができます。
      default voidinit​(EndpointConfig config)
      このメソッドは、このエンコーダーがサービスを開始しようとしているときに対象とするエンドポイントのエンドポイント構成オブジェクトを使用して呼び出されます。

    • メソッドの詳細

      • init

        default void init​(EndpointConfig config)
        このメソッドは、このエンコーダーがサービスを開始しようとしているときに対象とするエンドポイントのエンドポイント構成オブジェクトを使用して呼び出されます。
        パラメーター:
        config - サービス開始時のエンドポイント構成オブジェクト

      • destroy

        default void destroy()
        このメソッドは、エンコーダーがサービスから削除されようとしているときに呼び出され、エンコーダーが使用したリソースを適切に閉じることができます。