Class WebSocketMessage

Constructor Detail

• WebSocketMessage

  public WebSocketMessage​(WebSocketMessage.Type type,
                          DataBuffer payload)

  Constructor for a WebSocketMessage.

  See static factory methods in WebSocketSession or alternatively use WebSocketSession.bufferFactory() to create the payload and then invoke this constructor.

Method Detail

• getType

  public WebSocketMessage.Type getType()

  Return the message type (text, binary, etc).

• getPayload

  public DataBuffer getPayload()

  Return the message payload.

• getPayloadAsText

  public String getPayloadAsText()

  A variant of getPayloadAsText(Charset) that uses UTF-8 for decoding the raw content to text.

• getPayloadAsText

  public String getPayloadAsText​(Charset charset)

  A shortcut for decoding the raw content of the message to text with the given character encoding. This is useful for text WebSocket messages, or otherwise when the payload is expected to contain text.

  Parameters:

  charset - the character encoding

  Since:

  5.0.5

• retain

  public WebSocketMessage retain()

  Retain the data buffer for the message payload, which is useful on runtimes (e.g. Netty) with pooled buffers. A shortcut for:

   DataBuffer payload = message.getPayload();
   DataBufferUtils.retain(payload);
   

  See Also:

  DataBufferUtils.retain(DataBuffer)

• release

  public void release()

  Release the payload DataBuffer which is useful on runtimes (e.g. Netty) with pooled buffers such as Netty. A shortcut for:

   DataBuffer payload = message.getPayload();
   DataBufferUtils.release(payload);
   

  See Also:

  DataBufferUtils.release(DataBuffer)

• equals

  public boolean equals​(@Nullable
                        Object other)

  Overrides:

  equals in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• toString

  public String toString()

  Overrides:

  toString in class Object