org.projectodd.sockjs

Class SockJsServer.Options

java.lang.Object

org.projectodd.sockjs.SockJsServer.Options

Enclosing class:

SockJsServer

public static class SockJsServer.Options
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
String	baseUrl Users can specify a base URL which all client requests after an initial info request will be made against.
int	disconnectDelay The server sends a `close` event when a client receiving connection has not been seen for a while.
int	heartbeatDelay In order to keep proxies and load balancers from closing long running http requests we need to pretend that the connection is active and send a heartbeat packet once in a while.
boolean	jsessionid Some hosting providers enable sticky sessions only to requests that have a JSESSIONID cookie set.
int	responseLimit Most streaming transports save responses on the client side and don't free memory used by delivered messages.
String	sockjsUrl Transports which don't support cross-domain communication natively ('eventsource' to name one) use an iframe trick.
boolean	websocket Some load balancers don't support websockets.

Constructor Summary

Constructors

Constructor and Description
SockJsServer.Options()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sockjsUrl

public String sockjsUrl

Transports which don't support cross-domain communication natively ('eventsource' to name one) use an iframe trick. A simple page is served from the SockJS server (using its foreign domain) and is placed in an invisible iframe. Code run from this iframe doesn't need to worry about cross-domain issues, as it's being run from a domain local to the SockJS server. This iframe also needs to load the SockJS javascript client library, and this option lets you specify its url (if you're unsure, point it to the latest minified SockJS client release, this is the default). You must explicitly specify this url on the server side for security reasons - we don't want the possibility of running any foreign javascript within the SockJS domain (aka cross site scripting attack). Also, the sockjs javascript library is probably already cached by the browser - it makes sense to reuse the sockjs url you're normally using.

responseLimit

public int responseLimit

Most streaming transports save responses on the client side and don't free memory used by delivered messages. Such transports need to be garbage-collected once in a while. `responseLimit` sets a maximum number of bytes that can be send over a single http streaming request before it will be closed. After that client needs to open 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.

websocket

public boolean websocket

Some load balancers don't support websockets. This option can be used to disable websockets support by the server. By default websockets are enabled.

jsessionid

public boolean jsessionid

Some hosting providers enable sticky sessions only to requests that have a JSESSIONID cookie set. This setting controls if the server should set this cookie to a dummy value. By default setting of a JSESSIONID cookie is disabled.

heartbeatDelay

public int heartbeatDelay

In order to keep proxies and load balancers from closing long running http requests we need to pretend that the connection is active and send a heartbeat packet once in a while. This setting controls how often this is done. By default a heartbeat packet is sent every 25 seconds.

disconnectDelay

public int disconnectDelay

The server sends a `close` event when a client receiving connection has not been seen for a while. This delay is configured by this setting. By default the `close` event will be emitted when a receiving connection wasn't seen for 5 seconds.

baseUrl

public String baseUrl

Users can specify a base URL which all client requests after an initial info request will be made against. This probably is more useful as a method and not a static string, but that's not implemented yet.

Constructor Detail

SockJsServer.Options

public SockJsServer.Options()