public static interface RemoteEndpoint.Basic extends RemoteEndpoint
getSendStream
および getSendWriter
を除いて、この補完ポイントに到達するまで RemoteEndpoint.Basic ブロックでメッセージを送信するためのメソッド。 この RemoteEndpoint の基盤となる WebSocket 接続が、別のスレッドを送信するための呼び出しが行われたときにメッセージの送信でビジー状態になっている場合。たとえば、2 つのスレッドが send メソッドを同時に呼び出そうとした場合、または開発者が途中で新しいメッセージを送信しようとした場合。既存のものを送信する場合、接続がすでにビジー状態のときに呼び出された send メソッドは、IllegalStateException
SE をスローする可能性があります。
RemoteEndpoint.Async, RemoteEndpoint.Basic
修飾子と型 | メソッドと説明 |
---|---|
OutputStreamSE | getSendStream() バイナリメッセージを送信できる出力ストリームを開きます。 |
WriterSE | getSendWriter() テキストメッセージを送信できる文字ストリームを開きます。 |
void | sendBinary(ByteBufferSE data) バイナリメッセージを送信し、すべてのメッセージが送信されたときに戻ります。 |
void | sendBinary(ByteBufferSE partialByte, boolean isLast) バイナリメッセージを部分的に送信し、すべてのメッセージが送信されるまでブロックします。 |
void | sendObject(ObjectSE data) カスタム開発者オブジェクトを送信し、送信されるまでブロックします。 |
void | sendText(StringSE text) テキストメッセージを送信し、すべてのメッセージが送信されるまでブロックします。 |
void | sendText(StringSE partialMessage, boolean isLast) テキストメッセージを部分的に送信し、すべてのメッセージが送信されるまでブロックします。 |
flushBatch, getBatchingAllowed, sendPing, sendPong, setBatchingAllowed
void sendText(StringSE text) throws IOExceptionSE
text
- 送信するメッセージ。IOExceptionSE
- メッセージの配信に問題がある場合。IllegalArgumentExceptionSE
- テキストが null
の場合。void sendBinary(ByteBufferSE data) throws IOExceptionSE
このメッセージの送信が完了するまで、他のスレッドが ByteBuffer を使用することは安全ではありません。メッセージの送信が正常に完了すると、バッファーの制限は変更されず、バッファーの位置は制限と等しくなります。メッセージの送信が正常に完了しない場合、バッファの状態は未定義です。
data
- 送信するメッセージ。IOExceptionSE
- メッセージの配信に問題がある場合。IllegalArgumentExceptionSE
- データが null
の場合。void sendText(StringSE partialMessage, boolean isLast) throws IOExceptionSE
partialMessage
- 送信されるメッセージの部分。isLast
- 送信されている部分的なメッセージがメッセージの最後の部分であるかどうか。IOExceptionSE
- メッセージフラグメントの配信に問題がある場合。IllegalArgumentExceptionSE
- partialMessage が null
の場合。void sendBinary(ByteBufferSE partialByte, boolean isLast) throws IOExceptionSE
このパート的なメッセージの送信が完了するまで、他のスレッドが ByteBuffer を使用することは安全ではありません。部分的なメッセージの送信が正常に完了すると、バッファの制限は変更されず、バッファの位置は制限と等しくなります。部分的なメッセージの送信が正常に完了しない場合、バッファーの状態は未定義です。
partialByte
- 送信されるメッセージの一部。isLast
- 送信されている部分的なメッセージがメッセージの最後の部分であるかどうか。IOExceptionSE
- 部分的なメッセージの配信に問題がある場合。IllegalArgumentExceptionSE
- partialByte が null
の場合。OutputStreamSE getSendStream() throws IOExceptionSE
write()
メソッドのいずれかが呼び出されなかった場合、WebSocket バイナリメッセージは送信されません。出力ストリームが閉じられる前に、write()
メソッドの 1 つに対して少なくとも 1 回の呼び出しが行われると、メッセージの長さがゼロであっても、少なくとも 1 つの WebSocket バイナリメッセージが送信されます。IOExceptionSE
- バイナリメッセージを書き込むための OutputStream の取得に問題がある場合。WriterSE getSendWriter() throws IOExceptionSE
write()
または append()
メソッドのいずれかが呼び出されなかった場合、WebSocket テキストメッセージは送信されません。ライターが閉じられる前に、write()
または append()
メソッドのいずれかに対して少なくとも 1 回の呼び出しが行われると、メッセージの長さがゼロであっても、少なくとも 1 つの WebSocket テキストメッセージが送信されます。IOExceptionSE
- テキストメッセージを書き込むためのライターの取得に問題がある場合。void sendObject(ObjectSE data) throws IOExceptionSE, EncodeException
data
- 送信するオブジェクト。IOExceptionSE
- メッセージオブジェクトの送信中に通信エラーが発生した場合。EncodeException
- メッセージオブジェクトをネイティブ WebSocket メッセージの形式にエンコードする際に問題が発生した場合。IllegalArgumentExceptionSE
- データパラメーターが null
の場合 Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.