列挙定数の詳細

• NORMAL_CLOSURE

  public static final CloseReason.CloseCodes NORMAL_CLOSURE

  1000 は通常の閉包を示し、接続が確立された目的が達成されたことを意味します。

• GOING_AWAY

  public static final CloseReason.CloseCodes GOING_AWAY

  1001 は、サーバーがダウンしたり、ブラウザーがページから移動したりするなど、エンドポイントが「なくなる」ことを示します。

• PROTOCOL_ERROR

  public static final CloseReason.CloseCodes PROTOCOL_ERROR

  1002 は、プロトコルエラーが原因でエンドポイントが接続を終了していることを示します。

• CANNOT_ACCEPT

  public static final CloseReason.CloseCodes CANNOT_ACCEPT

  1003 は、エンドポイントが受け入れることができない型のデータを受信したために接続を終了していることを示します（たとえば、テキストデータのみを理解するエンドポイントは、バイナリメッセージを受信した場合にこれを送信できます）。

• RESERVED

  public static final CloseReason.CloseCodes RESERVED

  予約済み。具体的な意味は将来定義されるかもしれません。

• NO_STATUS_CODE

  public static final CloseReason.CloseCodes NO_STATUS_CODE

  1005 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。これは、ステータスコードが実際に存在しなかったことを示すステータスコードを期待するアプリケーションで使用するために指定されています。

• CLOSED_ABNORMALLY

  public static final CloseReason.CloseCodes CLOSED_ABNORMALLY

  1006 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。これは、接続が異常に閉じられたことを示すステータスコードを期待するアプリケーションで使用するために指定されています。たとえば、Close コントロールフレームを送受信しません。

• NOT_CONSISTENT

  public static final CloseReason.CloseCodes NOT_CONSISTENT

  1007 は、エンドポイントがメッセージの型と一致しないメッセージ内のデータ（たとえば、テキストメッセージ内の非 UTF-8 データ）を受信したために接続を終了していることを示します。

• VIOLATED_POLICY

  public static final CloseReason.CloseCodes VIOLATED_POLICY

  1008 は、ポリシーに違反するメッセージを受信したため、エンドポイントが接続を終了していることを示します。これは一般的なステータスコードであり、他に適切なステータスコード（1003 または 1009 など）がない場合、またはポリシーに関する特定の詳細を非表示にする必要がある場合に返されます。

• TOO_BIG

  public static final CloseReason.CloseCodes TOO_BIG

  1009 は、エンドポイントが大きすぎて処理できないメッセージを受信したため、エンドポイントが接続を終了していることを示します。

• NO_EXTENSION

  public static final CloseReason.CloseCodes NO_EXTENSION

  1010 は、サーバーが 1 つ以上の内線番号をネゴシエートすることを期待しているが、サーバーが WebSocket ハンドシェイクのレスポンスメッセージで返さなかったため、エンドポイント（クライアント）が接続を終了していることを示します。必要な拡張機能のリストは、閉じるフレームの /reason/ 部分に表示される必要があります。このステータスコードは、WebSocket ハンドシェイクに失敗する可能性があるため、サーバーでは使用されないことに注意してください。

• UNEXPECTED_CONDITION

  public static final CloseReason.CloseCodes UNEXPECTED_CONDITION

  1011 は、サーバーがリクエストを実行できない予期しない状態が発生したため、サーバーが接続を終了していることを示します。

• SERVICE_RESTART

  public static final CloseReason.CloseCodes SERVICE_RESTART

  1012 は、サービスが再起動されることを示します。

• TRY_AGAIN_LATER

  public static final CloseReason.CloseCodes TRY_AGAIN_LATER

  1013 は、サービスでオーバーロードが発生していることを示しています

• TLS_HANDSHAKE_FAILURE

  public static final CloseReason.CloseCodes TLS_HANDSHAKE_FAILURE

  1015 は予約値であり、エンドポイントによって Close コントロールフレームのステータスコードとして設定してはなりません（MUSTNOT）。これは、TLS ハンドシェイクの実行に失敗したために接続が閉じられたことを示すステータスコードを期待するアプリケーションで使用するように指定されています（たとえば、サーバー証明書を検証できません）。

メソッドの詳細

• values

  public static CloseReason.CloseCodes[] values()

  この列挙型の定数を含む配列を、宣言されている順序で返します。このメソッドは、次のように定数を反復するために使用できます。

  for (CloseReason.CloseCodes c : CloseReason.CloseCodes.values())
      System.out.println(c);
  

  戻り値:

  この列挙型の定数を宣言されている順序で含む配列

• valueOf

  public static CloseReason.CloseCodes valueOf​(StringSE name)

  指定された名前を持つこの型の列挙定数を返します。文字列は、この型の列挙定数を宣言するために使用される識別子と正確に一致する必要があります。(余分な空白文字は許可されません。)

  パラメーター:

  name - 返される列挙定数の名前。

  戻り値:

  指定された名前の列挙定数

  例外:

  IllegalArgumentExceptionSE - この列挙型に指定された名前の定数がない場合

  NullPointerExceptionSE - 引数が null の場合

• getCloseCode

  public static CloseReason.CloseCode getCloseCode​(int code)

  指定された int コード番号から CloseCode を作成します。int が次のいずれでもない場合、このメソッドは IllegalArgumentException をスローします。

  パラメーター:

  code - 整数コード番号

  戻り値:

  指定されたコード番号の新しい CloseCode

  例外:

  IllegalArgumentExceptionSE - コードが有効なクローズコードでない場合

• getCode

  public int getCode()

  このステータスコードのコード番号を返します。

  次で指定:

  インターフェース CloseReason.CloseCode の getCode 

  戻り値:

  コード。