HookupClientConfig

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

Instance Constructors

new HookupClientConfig(uri: URI, version: WebSocketVersion = WebSocketVersion.V13, initialHeaders: Map[String, String] = Map.empty, protocols: Seq[WireFormat] = DefaultProtocols, defaultProtocol: WireFormat = ..., pinging: Timeout = Timeout(60 seconds), buffer: Option[BackupBuffer] = 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

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
val buffer: Option[BackupBuffer]

The buffer to use when the connection to the server is lost.
def clone(): AnyRef

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

the default protocol this client should use
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val executionContext: ExecutionContext

The execution context for futures.
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def getDefaultProtocol(): WireFormat
def getExecutionContext(): ExecutionContext
def getInitialHeaders(): Map[String, String]
def getPinging(): Timeout
def getProtocols(): Seq[WireFormat]
def getThrottle(): Throttle
def getUri(): URI
def getVersion(): WebSocketVersion
val initialHeaders: Map[String, String]

The headers to send along with the handshake request.
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val pinging: Timeout

The timeout for pinging.
val protocols: Seq[WireFormat]

The protocols this websocket client can understand
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val throttle: Throttle

The throttle to use as reconnection schedule.
val uri: URI

The java.net.URI to connect to.
val version: WebSocketVersion

The version of the websocket handshake to use, defaults to the most recent version.
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package hookup

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val buffer: Option[BackupBuffer]

def clone(): AnyRef

val defaultProtocol: WireFormat

final def eq(arg0: AnyRef): Boolean

val executionContext: ExecutionContext

def finalize(): Unit

def getBuffer(): Option[BackupBuffer]

final def getClass(): Class[_]

def getDefaultProtocol(): WireFormat

def getExecutionContext(): ExecutionContext

def getInitialHeaders(): Map[String, String]

def getPinging(): Timeout

def getProtocols(): Seq[WireFormat]

def getThrottle(): Throttle

def getUri(): URI

def getVersion(): WebSocketVersion

val initialHeaders: Map[String, String]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val pinging: Timeout

val protocols: Seq[WireFormat]

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

val throttle: Throttle

val uri: URI

val version: WebSocketVersion

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped