Package io.deephaven.web.client.api

Class QueryConnectable<Self extends QueryConnectable<Self>>

java.lang.Object
io.deephaven.web.client.api.event.HasEventHandling
io.deephaven.web.client.api.QueryConnectable<Self>
Direct Known Subclasses:
IdeConnection
@TsIgnore public abstract class QueryConnectable<Self extends QueryConnectable<Self>> extends HasEventHandling
JS-exposed supertype handling details about connecting to a deephaven query worker. Wraps the WorkerConnection instance, which manages the connection to the API server.

  • Field Details

  • Constructor Details

    • QueryConnectable

      public QueryConnectable()

  • Method Details

    • getToken

      public abstract ConnectToken getToken()

    • getOptions

      public abstract ConnectOptions getOptions()

    • notifyConnectionError

      @Deprecated public void notifyConnectionError(ResponseStreamWrapper.Status status)
      Deprecated.

    • onConnected

      protected elemental2.promise.Promise<Void> onConnected()

    • getServerUrl

      @JsIgnore public String getServerUrl()

    • onReady

      @JsIgnore public elemental2.promise.Promise<Self> onReady()
      Internal method to permit delegating to some orchestration tool to see if this worker can be connected to yet.

    • running

      public abstract elemental2.promise.Promise<Self> running()
      Promise that resolves when this worker instance can be connected to, or rejects if it can't be used.
      Returns:
      A promise that resolves with this instance.

    • onLogMessage

      @JsMethod public JsRunnable onLogMessage(JsConsumer<LogItem> callback)
      Register a callback function to handle any log messages that are emitted on the server. Returns a function , which can be invoked to remove this log handler. Any log handler registered in this way will receive as many old log messages as are presently available.
      Parameters:
      callback -
      Returns:
      JsRunnable

    • startSession

      @JsMethod public CancellablePromise<IdeSession> startSession(String type)

    • getConsoleTypes

      @JsMethod public elemental2.promise.Promise<elemental2.core.JsArray<String>> getConsoleTypes()

    • getWorkerHeapInfo

      @JsMethod public elemental2.promise.Promise<JsWorkerHeapInfo> getWorkerHeapInfo()

    • connected

      public void connected()

    • close

      protected void close()

    • disconnected

      public void disconnected()
      Triggered when the connection has disconnected

    • notifyServerShutdown

      public abstract void notifyServerShutdown(TerminationNotificationResponse success)

    • supportsClientStreaming

      public boolean supportsClientStreaming()

    • createClient

      public <T> T createClient(BiFunction<String,Object,T> constructor)

    • makeRpcOptions

      public RpcOptions makeRpcOptions()