org.opengion.hayabusa.servlet

## クラス WebSocketClient

- java.lang.Object
- - javax.websocket.Endpoint
  - - org.opengion.hayabusa.servlet.WebSocketClient

-     public class WebSocketClient
      extends javax.websocket.Endpoint

       Websocket Endpoint implementation class WebSocketClient

       Client を実行するには、%CATALINA_HOME%/lib/websocket-api.jar ではだめです。
       META-INF\services\javax.websocket.ContainerProvider に、Provider を
       記述しておく必要があるそうです。

       方法としては、
        ① tyrus-standalone-client-jdk-1.13.1.jar を使用する。
        ② %CATALINA_HOME%/lib/tomcat-websocket.jar を使用する。
             この場合、依存関係で、/lib/tomcat-util.jar 、bin/tomcat-juli.jar も
             使用します。
           ※ 今現在、java Client は動いていません。

- - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `WebSocketClient()` デフォルトコンストラクター

  - ### メソッドのサマリー

    すべてのメソッド staticメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `static void` | `main(java.lang.String[] args)` メインメソッド。
    `void` | `onClose(javax.websocket.Session session, javax.websocket.CloseReason reason)` 3.切断時にコールされる。
    `void` | `onError(javax.websocket.Session session, java.lang.Throwable th)` 4.エラー時にコールされる。
    `void` | `onMessage(java.lang.String message, javax.websocket.Session session)` 5.テキストメッセージ受信時の処理 引数は使用しなければ省略可能。
    `void` | `onOpen(javax.websocket.Session session, javax.websocket.EndpointConfig config)` サーバーからの通知受信のためのコールバック 引数は以下が設定可能だが、メソッド内で使用しないなら省略できる。

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### WebSocketClient

          public WebSocketClient()

      デフォルトコンストラクター

  - ### メソッドの詳細

    - #### onOpen

          public void onOpen(javax.websocket.Session session,
                             javax.websocket.EndpointConfig config)

      サーバーからの通知受信のためのコールバック 引数は以下が設定可能だが、メソッド内で使用しないなら省略できる。
      定義:
        `onOpen` クラス内 `javax.websocket.Endpoint`
      パラメータ:
        `session` - サーバーの接続情報
        `config` - 設定情報

    - #### onMessage

          public void onMessage(java.lang.String message,
                                javax.websocket.Session session)

      5.テキストメッセージ受信時の処理 引数は使用しなければ省略可能。
      パラメータ:
        `message` - サーバーから送信されたテキスト
        `session` - 接続情報

    - #### onError

          public void onError(javax.websocket.Session session,
                              java.lang.Throwable th)

      4.エラー時にコールされる。 引数は使用しなければ省略可能。
      オーバーライド:
        `onError` クラス内 `javax.websocket.Endpoint`
      パラメータ:
        `session` - サーバーの接続情報
        `th` - エラー

    - #### onClose

          public void onClose(javax.websocket.Session session,
                              javax.websocket.CloseReason reason)

      3.切断時にコールされる。 引数は使用しなければ省略可能。
      オーバーライド:
        `onClose` クラス内 `javax.websocket.Endpoint`
      パラメータ:
        `session` - サーバーの接続情報
        `reason` - 切断理由

    - #### main

          public static void main(java.lang.String[] args)
                           throws javax.websocket.DeploymentException,
                                  java.io.IOException,
                                  java.lang.InterruptedException

      メインメソッド。
      パラメータ:
        `args` - 引数
      例外:
        `javax.websocket.DeploymentException` - WebSocketで、何らかの種類の障害が発生したことを示すチェック例外。
        `java.io.IOException` - なんらかの入出力例外の発生を通知するシグナルを発生させます。
        `java.lang.InterruptedException` - スレッドで割り込みが発生した場合にスローされます。

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.