org.springframework.web.socket.sockjs

Interface SockJsConfiguration

All Known Implementing Classes:

AbstractSockJsService, DefaultSockJsService

public interface SockJsConfiguration

SockJS configuration options that need to be made available to TransportHandler s and SockJS sessions.

Since:

4.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
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.
int	getStreamBytesLimit() Streaming transports save responses on the client side and don't free memory used by delivered messages.
TaskScheduler	getTaskScheduler() A scheduler instance to use for scheduling heart-beat messages.

Method Detail

getStreamBytesLimit

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).

getHeartbeatTime

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).

getTaskScheduler

TaskScheduler getTaskScheduler()

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