Class IdeConnection

Static Readonly EVENT_DISCONNECT

Static Readonly EVENT_RECONNECT

Static Readonly EVENT_SHUTDOWN

Static Readonly HACK_CONNECTION_FAILURE

addEventListener

• addEventListener<T>(name, callback): (() => void)

• Listen for events on this object.

  Type Parameters

  • T

    the type of the data that the event will provide

  Parameters

  • name: string

    the name of the event to listen for

  • callback: ((e) => void)

    a function to call when the event occurs

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns (() => void)

  Returns a cleanup function.

  • • (): void

    • Listen for events on this object.

      Returns void

      Returns a cleanup function.

close

• close(): void

• Closes the current connection, releasing any resources on the server or client.

  Returns void

getConsoleTypes

• getConsoleTypes(): Promise<string[]>

• Returns Promise<string[]>

getObject

• getObject(definitionObject): Promise<any>

• Parameters

  • definitionObject: VariableDescriptor

  Returns Promise<any>

getSharedObject

• getSharedObject(sharedTicketBytes, type): Promise<any>

• Reads an object shared by another client to this server with the sharedTicketBytes. Until the other client releases this object (or their session ends), the object will be available on the server.

  The type of the object must be passed so that the object can be read from the server correct - the other client should provide this information.

  Parameters

  • sharedTicketBytes: string | Uint8Array

    the value provided by another client/user to obtain the object. It may be a unicode string (will be encoded as utf8 bytes), or a Uint8Array value.

  • type: string

    The type of the object, so it can be correctly read from the server

  Returns Promise<any>

  A promise that will resolve to the shared object, or will reject with an error if it cannot be read.

getWorkerHeapInfo

• getWorkerHeapInfo(): Promise<WorkerHeapInfo>

• Returns Promise<WorkerHeapInfo>

hasListeners

• hasListeners(name): boolean

• Parameters

  • name: string

  Returns boolean

nextEvent

• nextEvent<T>(eventName, timeoutInMillis?): Promise<Event<T>>

• Type Parameters

  • T

  Parameters

  • eventName: string

  • Optional timeoutInMillis: number

  Returns Promise<Event<T>>

onLogMessage

• onLogMessage(callback): (() => void)

• 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: ((arg0) => void)

    • • (arg0): void

      • Parameters

        • arg0: LogItem

        Returns void

  Returns (() => void)

  io.deephaven.web.shared.fu.JsRunnable

  • • (): void

    • 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.

      Returns void

      io.deephaven.web.shared.fu.JsRunnable

removeEventListener

• removeEventListener<T>(name, callback): boolean

• Removes an event listener added to this table.

  Type Parameters

  • T

  Parameters

  • name: string

  • callback: ((e) => void)

    • • (e): void

      • Parameters

        • e: Event<T>

        Returns void

  Returns boolean

running

• running(): Promise<IdeConnection>

• Returns Promise<IdeConnection>

shareObject

• shareObject(object, sharedTicketBytes): Promise<string | Uint8Array>

• Makes an object available to another user or another client on this same server which knows the value of the sharedTicketBytes. Use that sharedTicketBytes value like a one-time use password - any other client which knows this value can read the same object.

  Shared objects will remain available using the sharedTicketBytes until the client that first shared them releases/closes their copy of the object. Whatever side-channel is used to share the bytes, be sure to wait until the remote end has signaled that it has successfully fetched the object before releasing it from this client.

  Be sure to use an unpredictable value for the shared ticket bytes, like a UUID or other large, random value to prevent access by unauthorized clients.

  Parameters

  • object: WidgetExportedObject | Widget | TotalsTable | Table | PartitionedTable | TreeTable

    the object to share with another client/user

  • sharedTicketBytes: string | Uint8Array

    the value which another client/user must know to obtain the object. It may be a unicode string (will be encoded as utf8 bytes), or a Uint8Array value.

  Returns Promise<string | Uint8Array>

  A promise that will resolve to the value passed as sharedTicketBytes when the object is ready to be read by another client, or will reject if an error occurs.

startSession

• startSession(type): Promise<IdeSession>

• Parameters

  • type: string

  Returns Promise<IdeSession>

subscribeToFieldUpdates

• subscribeToFieldUpdates(callback): (() => void)

• Parameters

  • callback: ((arg0) => void)

    • • (arg0): void

      • Parameters

        • arg0: VariableChanges

        Returns void

  Returns (() => void)

  • • (): void

    • Returns void