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] = scala.None, throttle: Throttle = NoThrottle, executionContext: ExecutionContext = HookupClient.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. HookupClientConfig
  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 HookupClientConfig(uri: URI, version: WebSocketVersion = ..., initialHeaders: Map[String, String] = ..., protocols: Seq[WireFormat] = ..., defaultProtocol: WireFormat = ..., pinging: Timeout = ..., buffer: Option[BackupBuffer] = scala.None, throttle: Throttle = NoThrottle, executionContext: ExecutionContext = HookupClient.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. 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. val buffer: Option[BackupBuffer]

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

  8. def clone(): AnyRef

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

  9. val defaultProtocol: WireFormat

    the default protocol this client should use

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

    Definition Classes
    AnyRef

  11. val executionContext: ExecutionContext

    The execution context for futures.

  12. def finalize(): Unit

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

  13. def getBuffer(): Option[BackupBuffer]

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

    Definition Classes
    AnyRef → Any

  15. def getDefaultProtocol(): WireFormat

  16. def getExecutionContext(): ExecutionContext

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

  18. def getPinging(): Timeout

  19. def getProtocols(): Seq[WireFormat]

  20. def getThrottle(): Throttle

  21. def getUri(): URI

  22. def getVersion(): WebSocketVersion

  23. val initialHeaders: Map[String, String]

    The headers to send along with the handshake request.

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  26. final def notify(): Unit

    Definition Classes
    AnyRef

  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  28. val pinging: Timeout

    The timeout for pinging.

  29. val protocols: Seq[WireFormat]

    The protocols this websocket client can understand

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

    Definition Classes
    AnyRef

  31. val throttle: Throttle

    The throttle to use as reconnection schedule.

  32. val uri: URI

    The java.net.URI to connect to.

  33. val version: WebSocketVersion

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

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped