Class

play.sockjs.api

SockJSSettings

Related Doc: package api

Permalink

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

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.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SockJSSettings
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    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.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def cookies(f: Option[(RequestHeader) ⇒ Cookie]): SockJSSettings

    Permalink
  7. def cookies(f: (RequestHeader) ⇒ Cookie): SockJSSettings

    Permalink
  8. val cookies: Option[(RequestHeader) ⇒ Cookie]

    Permalink

    Some hosting providers enable sticky sessions only to requests that have JSESSIONID cookie set.

    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.

  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def heartbeat(interval: FiniteDuration): SockJSSettings

    Permalink
  13. val heartbeat: FiniteDuration

    Permalink

    Interval at which heartbeat frame should be sent.

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

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def scriptSRC(f: (RequestHeader) ⇒ String): SockJSSettings

    Permalink
  19. val scriptSRC: (RequestHeader) ⇒ String

    Permalink

    A function to calculate SockJS script src.

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

  20. def sendBufferSize(size: Int): SockJSSettings

    Permalink
  21. val sendBufferSize: Int

    Permalink

    Maximum number of messages kept in the 'send' buffer, used by xhr_send and jsonp_send.

    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.

  22. def sessionBufferSize(size: Int): SockJSSettings

    Permalink
  23. val sessionBufferSize: Int

    Permalink

    Maximum size of the session buffer in bytes.

    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.

  24. def sessionTimeout(timeout: FiniteDuration): SockJSSettings

    Permalink
  25. val sessionTimeout: FiniteDuration

    Permalink

    The session will be closed if does not receive any connection during this time.

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

  26. def streamingQuota(quota: Long): SockJSSettings

    Permalink
  27. val streamingQuota: Long

    Permalink

    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.

    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.

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def websocket(enabled: Boolean): SockJSSettings

    Permalink
  33. val websocket: Boolean

    Permalink

    If true websocket are enabled, false otherwis.

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped