public class WebSocketMessage extends ObjectSE
セッションの DataBufferFactory
でメッセージを作成するには、WebSocketSession
の静的ファクトリメソッドを参照してください。
修飾子と型 | クラスと説明 |
---|---|
static class | WebSocketMessage.Type WebSocket メッセージ型。 |
コンストラクターと説明 |
---|
WebSocketMessage(WebSocketMessage.Type type, DataBuffer payload) WebSocketMessage のコンストラクター。 |
WebSocketMessage(WebSocketMessage.Type type, DataBuffer payload, ObjectSE nativeMessage) 基になるメッセージにアクセスできる受信メッセージのコンストラクター。 |
修飾子と型 | メソッドと説明 |
---|---|
boolean | equals(ObjectSE other) |
<T> T | getNativeMessage() 基礎となる WebSocket ライブラリの API からメッセージを返します。 |
DataBuffer | getPayload() メッセージのペイロードを返します。 |
StringSE | getPayloadAsText() 生のコンテンツをテキストにデコードするために UTF-8 を使用する getPayloadAsText(Charset) のバリアント。 |
StringSE | getPayloadAsText(CharsetSE charset) メッセージの生のコンテンツを、指定された文字エンコーディングでテキストにデコードするためのショートカット。 |
WebSocketMessage.Type | getType() メッセージの種類(テキスト、バイナリなど)を返します。 |
int | hashCode() |
void | release() ランタイムで役立つペイロード DataBuffer を解放します(例: |
WebSocketMessage | retain() メッセージペイロードのデータバッファーを保持します。これは、ランタイムで役立ちます(例: |
StringSE | toString() |
cloneSE, finalizeSE, getClassSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE
public WebSocketMessage(WebSocketMessage.Type type, DataBuffer payload)
WebSocketSession
の静的ファクトリメソッドを参照するか、WebSocketSession.bufferFactory()
を使用してペイロードを作成し、このコンストラクターを呼び出します。
public WebSocketMessage(WebSocketMessage.Type type, DataBuffer payload, @Nullable ObjectSE nativeMessage)
type
- WebSocket メッセージの型 payload
- メッセージの内容 nativeMessage
- 該当する場合、基礎となる WebSocket ライブラリの API からのメッセージ。public WebSocketMessage.Type getType()
public DataBuffer getPayload()
@Nullable public <T> T getNativeMessage()
T
- 基になるメッセージをキャストする型 null
public StringSE getPayloadAsText()
UTF-8
を使用する getPayloadAsText(Charset)
のバリアント。public StringSE getPayloadAsText(CharsetSE charset)
charset
- 文字エンコーディング public WebSocketMessage retain()
DataBuffer payload = message.getPayload(); DataBufferUtils.retain(payload);
public void release()
DataBuffer
を解放します。ショートカット:DataBuffer payload = message.getPayload(); DataBufferUtils.release(payload);
public int hashCode()
ObjectSE
の hashCodeSE
public StringSE toString()
ObjectSE
の toStringSE