org.springframework.web.socket.sockjs.frame

Class SockJsFrame

java.lang.Object

org.springframework.web.socket.sockjs.frame.SockJsFrame

public class SockJsFrame
extends java.lang.Object

Represents a SockJS frame. Provides factory methods to create SockJS frames.

Since:

4.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	CHARSET The charset used by SockJS.

Constructor Summary

Constructors

Constructor and Description
SockJsFrame(java.lang.String content) Create a new instance frame with the given frame content.

Method Summary

Modifier and Type	Method and Description
static SockJsFrame	closeFrame(int code, java.lang.String reason)
static SockJsFrame	closeFrameAnotherConnectionOpen()
static SockJsFrame	closeFrameGoAway()
boolean	equals(java.lang.Object other)
java.lang.String	getContent() Return the SockJS frame content (never null).
byte[]	getContentBytes() Return the SockJS frame content as a byte array.
java.lang.String	getFrameData() Return data contained in a SockJS "message" and "close" frames.
SockJsFrameType	getType() Return the SockJS frame type.
int	hashCode()
static SockJsFrame	heartbeatFrame()
static SockJsFrame	messageFrame(SockJsMessageCodec codec, java.lang.String... messages)
static SockJsFrame	openFrame()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CHARSET

public static final java.nio.charset.Charset CHARSET

The charset used by SockJS.

Constructor Detail

SockJsFrame

public SockJsFrame(java.lang.String content)

Create a new instance frame with the given frame content.

Parameters:

content - the content (must be a non-empty and represent a valid SockJS frame)

Method Detail

getType

public SockJsFrameType getType()

Return the SockJS frame type.

getContent

public java.lang.String getContent()

Return the SockJS frame content (never null).

getContentBytes

public byte[] getContentBytes()

Return the SockJS frame content as a byte array.

getFrameData

@Nullable
public java.lang.String getFrameData()

Return data contained in a SockJS "message" and "close" frames. Otherwise for SockJS "open" and "close" frames, which do not contain data, return null.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

openFrame

public static SockJsFrame openFrame()

heartbeatFrame

public static SockJsFrame heartbeatFrame()

messageFrame

public static SockJsFrame messageFrame(SockJsMessageCodec codec,
                                       java.lang.String... messages)

closeFrameGoAway

public static SockJsFrame closeFrameGoAway()

closeFrameAnotherConnectionOpen

public static SockJsFrame closeFrameAnotherConnectionOpen()

closeFrame

public static SockJsFrame closeFrame(int code,
                                     @Nullable
                                     java.lang.String reason)