Interface SockJsMessageCodec
- All Known Implementing Classes:
AbstractSockJsMessageCodec
,Jackson2SockJsMessageCodec
public interface SockJsMessageCodec
Encode and decode messages to and from a SockJS message frame,
essentially an array of JSON-encoded messages. For example:
a["message1","message2"]
- Since:
- 4.0
- Author:
- Rossen Stoyanchev
-
Method Summary
Modifier and TypeMethodDescriptionString[]
Decode the given SockJS message frame.String[]
decodeInputStream
(InputStream content) Decode the given SockJS message frame.Encode the given messages as a SockJS message frame.
-
Method Details
-
encode
Encode the given messages as a SockJS message frame. Aside from applying standard JSON quoting to each message, there are some additional JSON Unicode escaping rules. See the "JSON Unicode Encoding" section of SockJS protocol (i.e. the protocol test suite).- Parameters:
messages
- the messages to encode- Returns:
- the content for a SockJS message frame (never
null
)
-
decode
Decode the given SockJS message frame.- Parameters:
content
- the SockJS message frame- Returns:
- an array of messages, or
null
if none - Throws:
IOException
- if the content could not be parsed
-
decodeInputStream
Decode the given SockJS message frame.- Parameters:
content
- the SockJS message frame- Returns:
- an array of messages, or
null
if none - Throws:
IOException
- if the content could not be parsed
-