パッケージ org.springframework.web.reactive.socket

クラス WebSocketMessage

java.lang.ObjectSE
org.springframework.web.reactive.socket.WebSocketMessage
public class WebSocketMessage extends ObjectSE
WebSocket メッセージの表現。

セッションの DataBufferFactory でメッセージを作成するには、WebSocketSession の静的ファクトリメソッドを参照してください。

導入:
5.0
作成者:
Rossen Stoyanchev

  • コンストラクターの詳細

    • WebSocketMessage

      public WebSocketMessage(WebSocketMessage.Type type, DataBuffer payload)
      WebSocketMessage のコンストラクター。

      WebSocketSession の静的ファクトリメソッドを参照するか、WebSocketSession.bufferFactory() を使用してペイロードを作成し、このコンストラクターを呼び出します。

    • WebSocketMessage

      public WebSocketMessage(WebSocketMessage.Type type, DataBuffer payload, @Nullable ObjectSE nativeMessage)
      基になるメッセージにアクセスできる受信メッセージのコンストラクター。
      パラメーター:
      type - WebSocket メッセージの型
      payload - メッセージの内容
      nativeMessage - 該当する場合、基礎となる WebSocket ライブラリの API からのメッセージ。
      導入:
      5.3

  • メソッドの詳細

    • getType

      public WebSocketMessage.Type getType()
      メッセージの種類（テキスト、バイナリなど）を返します。

    • getPayload

      public DataBuffer getPayload()
      メッセージのペイロードを返します。

    • getNativeMessage

      @Nullable public <T> T getNativeMessage()
      基礎となる WebSocket ライブラリの API からメッセージを返します。これは、受信メッセージと、基になるメッセージにコンテンツ以外の追加フィールドがある場合にのみ適用されます。現在、これは Reactor Netty の場合のみです。
      型パラメーター:
      T - 基になるメッセージをキャストする型
      戻り値:
      基になるメッセージ、または null
      導入:
      5.3

    • getPayloadAsText

      public StringSE getPayloadAsText()
      生のコンテンツをテキストにデコードするために UTF-8 を使用する getPayloadAsText(Charset) のバリアント。

    • getPayloadAsText

      public StringSE getPayloadAsText(CharsetSE charset)
      メッセージの生のコンテンツを、指定された文字エンコーディングでテキストにデコードするためのショートカット。これは、テキストの WebSocket メッセージ、またはペイロードにテキストが含まれることが予想される場合に役立ちます。
      パラメーター:
      charset - 文字エンコーディング
      導入:
      5.0.5

    • retain

      public WebSocketMessage retain()
      メッセージペイロードのデータバッファーを保持します。これは、プールされたバッファーを使用するランタイム (Netty など) で役立ちます。次のショートカット:
       DataBuffer payload = message.getPayload();
 DataBufferUtils.retain(payload);
      関連事項:

    • release

      public void release()
      Netty などのプールされたバッファを持つランタイム (たとえば、Netty) で役立つペイロード DataBuffer を解放します。次のショートカット:
       DataBuffer payload = message.getPayload();
 DataBufferUtils.release(payload);
      関連事項:

    • equals

      public boolean equals(@Nullable ObjectSE other)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString