api

Type Members

1. sealed abstract class Frame extends AnyRef

   

   SockJS frames

2. trait SockJS extends Handler

   

   A SockJS handler.

3. case class SockJSCloseException(message: Close) extends RuntimeException with Product with Serializable

   

   An exception that, if thrown by a SockJS source, will cause the SockJS to be closed with the given close message.

   An exception that, if thrown by a SockJS source, will cause the SockJS to be closed with the given close message. This is a convenience that allows the SockJS to close with a particular close code without having to produce generic Messages.

4. trait SockJSRouter extends Router

   

5. case class SockJSSettings(scriptSRC: (RequestHeader) ⇒ String = ..., websocket: Boolean = true, cookies: Option[(RequestHeader) ⇒ Cookie] = None, heartbeat: FiniteDuration = 25.seconds, sessionTimeout: FiniteDuration = 5.seconds, streamingQuota: Long = 128*1024, sendBufferSize: Int = 256, sessionBufferSize: Int = 64*1024) extends Product with Serializable

   

   SockJS server settings

   SockJS server settings

   scriptSRC

   A function to calculate SockJS script src. Defaults to "http://cdn.sockjs.org/sockjs-0.3.min.js".

   websocket

   If true websocket are enabled, false otherwis. Defaults to true.

   cookies

   Some hosting providers enable sticky sessions only to requests that have JSESSIONID cookie set. This setting controls if the server should set this cookie to a dummy value. By default setting JSESSIONID cookie is disabled. More sophisticated behaviour can be achieved by supplying a SockJSSettings.CookieCalculator.

   heartbeat

   Interval at which heartbeat frame should be sent. Defaults to 25 seconds.

   sessionTimeout

   The session will be closed if does not receive any connection during this time. Defaults to 5 seconds.

   streamingQuota

   Quota in bytes for a single streaming request: after the quota is reached the request will be closed by the server to let the client GC received messages. Defaults to 128Kb.

   sendBufferSize

   Maximum number of messages kept in the 'send' buffer, used by xhr_send and jsonp_send. If the buffer fills further messages will be rejected. Defaults to 256.

   sessionBufferSize

   Maximum size of the session buffer in bytes. Transports that emulate websocket needs to store outgoing messages in between client reconnects (after a long poll or a streaming request completes). When the buffer fills the session flow will backpressure. Defaults to 64Kb.