play.sockjs.api

SockJSSettings

case class SockJSSettings(scriptSRC: (RequestHeader) ⇒ String = ..., websocket: Boolean = true, cookies: Option[SockJSSettings.CookieCalculator] = scala.None, heartbeat: FiniteDuration = ..., sessionTimeout: FiniteDuration = ..., streamingQuota: Long = 128.*(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 function.

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 4096 bytes.

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
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SockJSSettings(scriptSRC: (RequestHeader) ⇒ String = ..., websocket: Boolean = true, cookies: Option[SockJSSettings.CookieCalculator] = scala.None, heartbeat: FiniteDuration = ..., sessionTimeout: FiniteDuration = ..., streamingQuota: Long = 128.*(1024))

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

    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 4096 bytes.

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def cookies(cookies: SockJSSettings.CookieCalculator): SockJSSettings

  9. val cookies: Option[SockJSSettings.CookieCalculator]

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

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

    Definition Classes
    AnyRef

  11. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  12. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  13. def heartbeat(interval: FiniteDuration): SockJSSettings

  14. val heartbeat: FiniteDuration

    Interval at which heartbeat frame should be sent.

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

  15. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  19. def scriptSRC(src: (RequestHeader) ⇒ String): SockJSSettings

  20. val scriptSRC: (RequestHeader) ⇒ String

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

  21. def sessionTimeout(timeout: FiniteDuration): SockJSSettings

  22. val sessionTimeout: FiniteDuration

    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.

  23. def streamingQuota(quota: Long): SockJSSettings

  24. val streamingQuota: Long

    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 4096 bytes.

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

    Definition Classes
    AnyRef

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def websocket(enabled: Boolean): SockJSSettings

  30. val websocket: Boolean

    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