io.backchat.hookup

HookupClientConfig

case class HookupClientConfig (uri: URI, version: WebSocketVersion, initialHeaders: Map[String, String], protocols: Seq[WireFormat], defaultProtocol: WireFormat, pinging: Timeout, buffer: Option[BackupBuffer], throttle: Throttle, executionContext: ExecutionContext) extends Product with Serializable

The configuration of a websocket client.

uri

The java.net.URI to connect to.

version

The version of the websocket handshake to use, defaults to the most recent version.

initialHeaders

The headers to send along with the handshake request.

protocols

The protocols this websocket client can understand

defaultProtocol

the default protocol this client should use

pinging

The timeout for pinging.

buffer

The buffer to use when the connection to the server is lost.

throttle

The throttle to use as reconnection schedule.

executionContext

The execution context for futures.

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

Instance Constructors

  1. new HookupClientConfig (uri: URI, version: WebSocketVersion, initialHeaders: Map[String, String], protocols: Seq[WireFormat], defaultProtocol: WireFormat, pinging: Timeout, buffer: Option[BackupBuffer], throttle: Throttle, executionContext: ExecutionContext)

    uri

    The java.net.URI to connect to.

    version

    The version of the websocket handshake to use, defaults to the most recent version.

    initialHeaders

    The headers to send along with the handshake request.

    protocols

    The protocols this websocket client can understand

    defaultProtocol

    the default protocol this client should use

    pinging

    The timeout for pinging.

    buffer

    The buffer to use when the connection to the server is lost.

    throttle

    The throttle to use as reconnection schedule.

    executionContext

    The execution context for futures.

Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  6. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  7. val buffer : Option[BackupBuffer]

    The buffer to use when the connection to the server is lost.

  8. def canEqual (arg0: Any): Boolean

    Definition Classes
    HookupClientConfig → Equals
  9. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  10. val defaultProtocol : WireFormat

    the default protocol this client should use

  11. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  12. def equals (arg0: Any): Boolean

    Definition Classes
    HookupClientConfig → Equals → AnyRef → Any
  13. val executionContext : ExecutionContext

    The execution context for futures.

  14. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. def getBuffer (): Option[BackupBuffer]

  16. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  17. def getDefaultProtocol (): WireFormat

  18. def getExecutionContext (): ExecutionContext

  19. def getInitialHeaders (): Map[String, String]

  20. def getPinging (): Timeout

  21. def getProtocols (): Seq[WireFormat]

  22. def getThrottle (): Throttle

  23. def getUri (): URI

  24. def getVersion (): WebSocketVersion

  25. def hashCode (): Int

    Definition Classes
    HookupClientConfig → AnyRef → Any
  26. val initialHeaders : Map[String, String]

    The headers to send along with the handshake request.

  27. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  28. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  29. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  30. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  31. val pinging : Timeout

    The timeout for pinging.

  32. def productArity : Int

    Definition Classes
    HookupClientConfig → Product
  33. def productElement (arg0: Int): Any

    Definition Classes
    HookupClientConfig → Product
  34. def productIterator : Iterator[Any]

    Definition Classes
    Product
  35. def productPrefix : String

    Definition Classes
    HookupClientConfig → Product
  36. val protocols : Seq[WireFormat]

    The protocols this websocket client can understand

  37. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  38. val throttle : Throttle

    The throttle to use as reconnection schedule.

  39. def toString (): String

    Definition Classes
    HookupClientConfig → AnyRef → Any
  40. val uri : URI

    The java.net.URI to connect to.

  41. val version : WebSocketVersion

    The version of the websocket handshake to use, defaults to the most recent version.

  42. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def productElements : Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any