Package io.deephaven.web.client.api

Class ConnectOptions

java.lang.Object

io.deephaven.web.client.api.ConnectOptions

@JsType(namespace="dh")
public class ConnectOptions
extends Object

Addition optional configuration that can be passed to the CoreClient constructor.

Field Summary

Fields

Modifier and Type	Field	Description
@jsinterop.annotations.JsNullable boolean	debug	True to enable debug logging.
@JsNullable jsinterop.base.JsPropertyMap<String>	headers	Optional map of http header names and values to send to the server with each request.
@JsNullable GrpcTransportFactory	transportFactory	The transport factory to use for creating gRPC streams.
@JsNullable Boolean	useWebsockets	Set this to true to force the use of websockets when connecting to the deephaven instance, false to force the use of fetch.

Constructor Summary

Constructors

Constructor	Description
ConnectOptions()
ConnectOptions(Object connectOptions)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

headers

public @JsNullable jsinterop.base.JsPropertyMap<String> headers

Optional map of http header names and values to send to the server with each request.

debug

public @jsinterop.annotations.JsNullable boolean debug

True to enable debug logging. At this time, only enables logging for gRPC calls.

useWebsockets

public @JsNullable Boolean useWebsockets

Set this to true to force the use of websockets when connecting to the deephaven instance, false to force the use of fetch. Ignored if transportFactory is set.

Defaults to null, indicating that the server URL should be checked to see if we connect with fetch or websockets.

transportFactory

public @JsNullable GrpcTransportFactory transportFactory

The transport factory to use for creating gRPC streams. If specified, the JS API will ignore useWebsockets and its own internal logic for determining the appropriate transport to use.

Defaults to null, indicating that the JS API should determine the appropriate transport to use. If useWebsockets is set to true, the JS API will use websockets, otherwise if the server url begins with https, it will use fetch, otherwise it will use websockets.

Constructor Details

ConnectOptions

public ConnectOptions()

ConnectOptions

@JsIgnore
public ConnectOptions(Object connectOptions)