パッケージ org.opengion.hayabusa.servlet

## クラス WebSocketDemo

- java.lang.Object
- - org.opengion.hayabusa.servlet.WebSocketDemo

-     public class WebSocketDemo
      extends Object

  http://enterprisegeeks.hatenablog.com/entry/2015/12/17/104815 WebSocketBasicEndpoint.java のソースを参照しています。 設定が、いくつか必要です。 ① /wsdemo をサーバーエンドポイントのURLにしているため WEB-INF/web.xml の security-constraint の web-resource-collection の url-pattern に、/wsdemo を追加する必要がある。 <url-pattern>/wsdemo/*</url-pattern> ② コンパイル時(build.xml)のクラスパスの設定に、 <pathelement path="${env.CATALINA_HOME}/lib/websocket-api.jar" /> を追加する必要がある。

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタ | 説明
    --- | ---
    `WebSocketDemo()` | デフォルトコンストラクター

  - ### メソッドの概要

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッド | 説明
    --- | --- | ---
    `void` | `onClose​(javax.websocket.Session client, javax.websocket.CloseReason reason)` | 3.クライアントの切断時にコールされる 引数は使用しなければ省略可能。
    `void` | `onError​(javax.websocket.Session client, Throwable error)` | 4.エラー時にコールされる。
    `void` | `onMessage​(String text, javax.websocket.Session client)` | 5.テキストメッセージ受信時の処理 全クライアントにメッセージを送信する。
    `void` | `onMessage​(ByteBuffer buf, javax.websocket.Session client)` | 6.バイナリ受信時の処理 送信元に画像を変換して送り返す。
    `void` | `onOpen​(javax.websocket.Session client, javax.websocket.EndpointConfig config)` | 2.クライアントからの接続時にコールされる。

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

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

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

    - #### WebSocketDemo

          public WebSocketDemo()

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

  - ### メソッドの詳細

    - #### onOpen

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

      2.クライアントからの接続時にコールされる。 引数は以下が設定可能だが、メソッド内で使用しないなら省略できる。
      パラメータ:
        `client` - クライアントの接続情報
        `config` - 設定情報
      変更履歴:
        6.8.5.0 (2018/01/09) PMD Variables that are final and static should be all capitals。sessSET → SESS_SET

    - #### onClose

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

      3.クライアントの切断時にコールされる 引数は使用しなければ省略可能。
      パラメータ:
        `client` - 接続
        `reason` - 切断理由
      変更履歴:
        6.8.5.0 (2018/01/09) PMD Variables that are final and static should be all capitals。sessSET → SESS_SET

    - #### onError

          public void onError​(javax.websocket.Session client,
                              Throwable error)

      4.エラー時にコールされる。 引数は使用しなければ省略可能。
      パラメータ:
        `client` - クライアント接続
        `error` - エラー

    - #### onMessage

          public void onMessage​(String text,
                                javax.websocket.Session client)
                         throws IOException

      5.テキストメッセージ受信時の処理 全クライアントにメッセージを送信する。（サンプル） 引数は使用しなければ省略可能。
      パラメータ:
        `text` - クライアントから送信されたテキスト
        `client` - 接続情報
      例外:
        `IOException` - なんらかの入出力例外の発生を通知するシグナルを発生させます。

    - #### onMessage

          public void onMessage​(ByteBuffer buf,
                                javax.websocket.Session client)
                         throws IOException

      6.バイナリ受信時の処理 送信元に画像を変換して送り返す。 引数は使用しなければ省略可能。
      パラメータ:
        `buf` - クライアントから送信されたバイナリ
        `client` - 接続情報
      例外:
        `IOException` - なんらかの入出力例外の発生を通知するシグナルを発生させます。