Top Description Methods
org.springframework.web.socket.sockjs.transport

public Interface SockJsServiceConfig

Known Direct Implementers
org.springframework.web.socket.sockjs.transport.TransportHandlingSockJsService
Imports
org.springframework.scheduling.TaskScheduler, org.springframework.web.socket.sockjs.SockJsService, org.springframework.web.socket.sockjs.frame.SockJsMessageCodec
Provides transport handling code with access to the SockJsService configuration options they need to have access to. Mainly for internal use.
Author
Rossen Stoyanchev
Since
4.0

Method Summary

Modifier and TypeMethod and Description
public long
getHeartbeatTime()

The amount of time in milliseconds when the server has not sent any messages and after which the server should send a heartbeat frame to the client in order to keep the connection from breaking.

public int
getHttpMessageCacheSize()

The number of server-to-client messages that a session can cache while waiting for the next HTTP polling request from the client.

public SockJsMessageCodec
getMessageCodec()

The codec to use for encoding and decoding SockJS messages.

public int
getStreamBytesLimit()

Streaming transports save responses on the client side and don't free memory used by delivered messages.

public TaskScheduler
getTaskScheduler()

A scheduler instance to use for scheduling heart-beat messages.

Method Detail

getHeartbeatTimeback to summary
public long getHeartbeatTime()

The amount of time in milliseconds when the server has not sent any messages and after which the server should send a heartbeat frame to the client in order to keep the connection from breaking.

The default value is 25,000 (25 seconds).

getHttpMessageCacheSizeback to summary
public int getHttpMessageCacheSize()

The number of server-to-client messages that a session can cache while waiting for the next HTTP polling request from the client. All HTTP transports use this property since even streaming transports recycle HTTP requests periodically.

The amount of time between HTTP requests should be relatively brief and will not exceed the allows disconnect delay (see org.springframework.web.socket.sockjs.support.AbstractSockJsService#setDisconnectDelay(long)), 5 seconds by default.

The default size is 100.

getMessageCodecback to summary
public SockJsMessageCodec getMessageCodec()

The codec to use for encoding and decoding SockJS messages.

Exceptions
IllegalStateException:
if no SockJsMessageCodec is available
getStreamBytesLimitback to summary
public int getStreamBytesLimit()

Streaming transports save responses on the client side and don't free memory used by delivered messages. Such transports need to recycle the connection once in a while. This property sets a minimum number of bytes that can be send over a single HTTP streaming request before it will be closed. After that client will open a new request. Setting this value to one effectively disables streaming and will make streaming transports to behave like polling transports.

The default value is 128K (i.e. 128 * 1024).

getTaskSchedulerback to summary
public TaskScheduler getTaskScheduler()

A scheduler instance to use for scheduling heart-beat messages.