org.springframework.web.socket.sockjs.frame

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 Type	Method and Description
java.lang.String[]	decode(java.lang.String content) Decode the given SockJS message frame.
java.lang.String[]	decodeInputStream(java.io.InputStream content) Decode the given SockJS message frame.
java.lang.String	encode(java.lang.String... messages) Encode the given messages as a SockJS message frame.

Method Detail

encode

java.lang.String encode(java.lang.String... messages)

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

@Nullable
java.lang.String[] decode(java.lang.String content)
                             throws java.io.IOException

Decode the given SockJS message frame.

Parameters:

content - the SockJS message frame

Returns:

an array of messages, or null if none

Throws:

java.io.IOException - if the content could not be parsed

decodeInputStream

@Nullable
java.lang.String[] decodeInputStream(java.io.InputStream content)
                                        throws java.io.IOException

Decode the given SockJS message frame.

Parameters:

content - the SockJS message frame

Returns:

an array of messages, or null if none

Throws:

java.io.IOException - if the content could not be parsed