Package org.springframework.web.socket
Class TextMessage
java.lang.Object
org.springframework.web.socket.AbstractWebSocketMessage<String>
org.springframework.web.socket.TextMessage
- All Implemented Interfaces:
WebSocketMessage<String>
A text WebSocket message.
- Since:
- 4.0
- Author:
- Rossen Stoyanchev
-
Constructor Summary
ConstructorDescriptionTextMessage
(byte[] payload) Create a new text WebSocket message from the given byte[].TextMessage
(CharSequence payload) Create a new text WebSocket message from the given CharSequence payload.TextMessage
(CharSequence payload, boolean isLast) Create a new text WebSocket message with the given payload representing the full or partial message content. -
Method Summary
Methods inherited from class org.springframework.web.socket.AbstractWebSocketMessage
equals, getPayload, hashCode, isLast, toString
-
Constructor Details
-
TextMessage
Create a new text WebSocket message from the given CharSequence payload.- Parameters:
payload
- the non-null payload
-
TextMessage
public TextMessage(byte[] payload) Create a new text WebSocket message from the given byte[]. It is assumed the byte array can be encoded into an UTF-8 String.- Parameters:
payload
- the non-null payload
-
TextMessage
Create a new text WebSocket message with the given payload representing the full or partial message content. When theisLast
boolean flag is set tofalse
the message is sent as partial content and more partial messages will be expected until the boolean flag is set totrue
.- Parameters:
payload
- the non-null payloadisLast
- whether this the last part of a series of partial messages
-
-
Method Details
-
getPayloadLength
public int getPayloadLength()Description copied from interface:WebSocketMessage
Return the number of bytes contained in the message. -
asBytes
public byte[] asBytes() -
toStringPayload
- Specified by:
toStringPayload
in classAbstractWebSocketMessage<String>
-