Top Description Methods
org.springframework.web.socket

public Interface WebSocketMessage<T>

Known Direct Implementers
org.springframework.web.socket.AbstractWebSocketMessage
Type Parameters
<T>
the payload type
A message that can be handled or sent on a WebSocket connection.
Author
Rossen Stoyanchev
Since
4.0

Method Summary

Modifier and TypeMethod and Description
public T
getPayload()

Return the message payload (never null).

public int
getPayloadLength()

Return the number of bytes contained in the message.

public boolean
isLast()

When partial message support is available and requested via org.springframework.web.socket.WebSocketHandler#supportsPartialMessages(), this method returns true if the current message is the last part of the complete WebSocket message sent by the client.

Method Detail

getPayloadback to summary
public T getPayload()

Return the message payload (never null).

getPayloadLengthback to summary
public int getPayloadLength()

Return the number of bytes contained in the message.

isLastback to summary
public boolean isLast()

When partial message support is available and requested via org.springframework.web.socket.WebSocketHandler#supportsPartialMessages(), this method returns true if the current message is the last part of the complete WebSocket message sent by the client. Otherwise false is returned if partial message support is either not available or not enabled.