メソッドの詳細

• getSendTimeout

  long getSendTimeout()

  実装が websocket メッセージを送信しようとしてタイムアウトするミリ秒数を返します。ゼロまたは負の値は、実装が Websocket メッセージを非同期に送信しようとしてタイムアウトしないことを示します。この値は、WebSocketContainer で割り当てられたデフォルト値をオーバーライドします。

  戻り値:

  ミリ秒単位のタイムアウト時間。

• setSendTimeout

  void setSendTimeout​(long timeoutmillis)

  実装が Websocket メッセージを送信しようとしてタイムアウトするミリ秒数を設定します。ゼロまたは負の値は、実装が Websocket メッセージを非同期に送信しようとしてタイムアウトしないことを示します。この値は、WebSocketContainer で割り当てられたデフォルト値をオーバーライドします。

  パラメーター:

  timeoutmillis - この RemoteEndpoint が不完全な非同期メッセージ送信をタイムアウトするまで待機するミリ秒数。

• sendText

  void sendText​(StringSE text,
                SendHandler handler)

  テキストメッセージの非同期送信を開始します。このメソッドは、メッセージが送信される前に戻ります。開発者は、メッセージが送信されたときに通知されるコールバックを提供します。送信エラーは、SendResult オブジェクトで開発者に提供されます。

  パラメーター:

  text - 送信されるテキスト。

  handler - 進捗状況を通知されるハンドラー。

  例外:

  IllegalArgumentExceptionSE - テキストまたはハンドラーが null の場合。

• sendText

  FutureSE<VoidSE> sendText​(StringSE text)

  テキストメッセージの非同期送信を開始します。このメソッドは、メッセージが送信される前に戻ります。開発者は、返された Future オブジェクトを使用して、送信の進行状況を追跡します。Future の get() メソッドは、正常に完了すると null を返します。転送エラーは、Future オブジェクトのクエリ時にスローされる ExecutionExceptionSE にラップされます。

  パラメーター:

  text - 送信されるテキスト。

  戻り値:

  送信操作を表す Future オブジェクト。

  例外:

  IllegalArgumentExceptionSE - テキストが null の場合。

• sendBinary

  FutureSE<VoidSE> sendBinary​(ByteBufferSE data)

  バイナリメッセージの非同期送信を開始します。このメソッドは、メッセージが送信される前に戻ります。開発者は、返された Future オブジェクトを使用して、送信の進行状況を追跡します。Future の get() メソッドは、正常に完了すると null を返します。転送エラーは、Future オブジェクトのクエリ時にスローされる ExecutionExceptionSE にラップされます。

  このメッセージの送信が完了するまで、他のスレッドが ByteBuffer を使用することは安全ではありません。メッセージの送信が正常に完了すると、バッファーの制限は変更されず、バッファーの位置は制限と等しくなります。メッセージの送信が正常に完了しない場合、バッファの状態は未定義です。

  パラメーター:

  data - 送信されるデータ。

  戻り値:

  送信操作を表す Future オブジェクト。

  例外:

  IllegalArgumentExceptionSE - データが null の場合。

• sendBinary

  void sendBinary​(ByteBufferSE data,
                  SendHandler handler)

  バイナリメッセージの非同期送信を開始します。このメソッドは、メッセージが送信される前に戻ります。開発者は、メッセージが送信されたときに通知されるコールバックを提供します。送信エラーは、SendResult オブジェクトで開発者に提供されます。

  このメッセージの送信が完了するまで、他のスレッドが ByteBuffer を使用することは安全ではありません。メッセージの送信が正常に完了すると、バッファーの制限は変更されず、バッファーの位置は制限と等しくなります。メッセージの送信が正常に完了しない場合、バッファの状態は未定義です。

  パラメーター:

  data - 送信されるデータ。null であってはなりません。

  handler - 進行状況を通知されるハンドラー。null であってはなりません。

  例外:

  IllegalArgumentExceptionSE - データまたはハンドラーが null の場合。

• sendObject

  FutureSE<VoidSE> sendObject​(ObjectSE data)

  カスタム開発者オブジェクトの非同期送信を開始します。開発者は、エンドポイント構成でこのオブジェクト型のエンコーダーを提供します。コンテナーは、デフォルトで java プリミティブ型とそれに相当するオブジェクトをエンコードできます。それ以外の場合、開発者はエンドポイント構成でオブジェクト型のエンコーダーを提供する必要があります。開発者が提供する Java プリミティブ型のエンコーダーとそれに相当するオブジェクトは、コンテナーのデフォルトエンコーダーをオーバーライドします。進行状況は、Future オブジェクトを使用して追跡できます。Future の get() メソッドは、正常に完了すると null を返します。送信エラーは、Future オブジェクトを照会するときにスローされる ExecutionExceptionSE にラップされます。

  パラメーター:

  data - 送信されるオブジェクト。

  戻り値:

  送信操作を表す Future オブジェクト。

  例外:

  IllegalArgumentExceptionSE - データが null の場合。

• sendObject

  void sendObject​(ObjectSE data,
                  SendHandler handler)

  カスタム開発者オブジェクトの非同期送信を開始します。コンテナーは、デフォルトで java プリミティブ型とそれに相当するオブジェクトをエンコードできます。それ以外の場合、開発者はエンドポイント構成でオブジェクト型のエンコーダーを提供する必要があります。開発者が提供する Java プリミティブ型のエンコーダーとそれに相当するオブジェクトは、コンテナーのデフォルトエンコーダーをオーバーライドします。提供されたコールバックオブジェクトを介して送信が完了すると、開発者に通知されます。

  パラメーター:

  data - 送信されるオブジェクト。

  handler - 進行状況を通知されるハンドラー。null であってはなりません。

  例外:

  IllegalArgumentExceptionSE - データまたはハンドラーが null の場合。