パッケージ jakarta.websocket

アノテーションインターフェース ClientEndpoint

@RetentionSE(RUNTIMESE) @TargetSE(TYPESE) public @interface ClientEndpoint
ClientEndpoint アノテーションクラスレベルアノテーションは、POJO が Web ソケットクライアントであり、そのようにデプロイできることを示すために使用されます。jakarta.websocket.server.ServerEndpoint と同様に、このアノテーションが付けられた POJO には、Web ソケットメソッドレベルのアノテーションを使用して Web ソケットライフサイクルメソッドであるメソッドを含めることができます。

例:

 
 @ClientEndpoint(subprotocols="chat")
 public class HelloServer {

     @OnMessage
     public void processMessageFromServer(String message, Session session) {
         System.out.println("Message came from the server ! " + message);
     }

 }
作成者:
dannycoward

  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    ClassSE<? extends ClientEndpointConfig.Configurator>
    configurator
    このエンドポイントの新しいインスタンスのカスタム構成を提供するために開発者が使用したいオプションのカスタムコンフィギュレータークラス。
    ClassSE<? extends Decoder>[]
    decoders
    クライアントに受信するメッセージのデコーダーとして機能する Java クラスの配列。
    ClassSE<? extends Encoder>[]
    encoders
    クライアントから送信されたメッセージのエンコーダーとして機能する Java クラスの配列。
    StringSE[]
    subprotocols
    このクライアントがサポートするサブプロトコルの名前。

  • 要素の詳細

    • subprotocols

      StringSE[] subprotocols
      このクライアントがサポートするサブプロトコルの名前。
      戻り値:
      サブプロトコルの名前の配列。
      デフォルト:
      {}

    • decoders

      ClassSE<? extends Decoder>[] decoders
      クライアントに受信するメッセージのデコーダーとして機能する Java クラスの配列。
      戻り値:
      デコーダの配列。
      デフォルト:
      {}

    • encoders

      ClassSE<? extends Encoder>[] encoders
      クライアントから送信されたメッセージのエンコーダーとして機能する Java クラスの配列。
      戻り値:
      デコーダの配列。
      デフォルト:
      {}

    • configurator

      ClassSE<? extends ClientEndpointConfig.Configurator> configurator
      このエンドポイントの新しいインスタンスのカスタム構成を提供するために開発者が使用したいオプションのカスタムコンフィギュレータークラス。実装は、論理エンドポイントごとにコンフィギュレーターの新しいインスタンスを作成します。
      戻り値:
      カスタムコンフィギュレータークラス、またはアノテーションに何も指定されていない場合は ClientEndpointConfigurator.class。
      デフォルト:
      jakarta.websocket.ClientEndpointConfig.Configurator.class