Package io.deephaven.web.client.api

Class WorkerConnection

java.lang.Object

io.deephaven.web.client.api.WorkerConnection

@TsIgnore
public class WorkerConnection
extends Object

Non-exported class, manages the connection to a given worker server. Exported types like QueryInfo and Table will refer to this, and allow us to try to keep track of how many open tables there are, so we can close the connection if not in use. Might make more sense to be part of QueryInfo, but this way we can WeakMap instances, check periodically if any QueryInfos are left alive or event handlers still exist, and close connections that seem unused. Except for the delegated call from QueryInfo.getTable, none of these calls will be possible in Connecting or Disconnected state if done right. Failed state is possible, and we will want to think more about handling, possible re-Promise-ing all of the things, or just return stale values if we have them. Responsible for reconnecting to the query server when required - when that server disappears, and at least one table is left un-closed.

Constructor Summary

Constructors

Constructor	Description
WorkerConnection(QueryConnectable<?> info)

Method Summary

Modifier and Type	Method	Description
BrowserFlightServiceClient	browserFlightServiceClient()
boolean	checkStatus(ResponseStreamWrapper.Status status)
ConfigServiceClient	configServiceClient()
void	connectionLost()
ConsoleServiceClient	consoleServiceClient()
String	dump(String graphName)
elemental2.promise.Promise<JsTable>	emptyTable(double size)
void	exportedTableUpdateMessage(TableTicket clientId, long size)
FlightServiceClient	flightServiceClient()
void	forceClose()
void	forceReconnect()
RequestBatcher	getBatcher(JsTable table)
StateCache	getCache()
elemental2.promise.Promise<JsFigure>	getFigure(JsVariableDefinition varDef)
elemental2.promise.Promise<JsTreeTable>	getHierarchicalTable(JsVariableDefinition varDef)
elemental2.promise.Promise<?>	getJsObject(jsinterop.base.JsPropertyMap<Object> definitionObject)
elemental2.promise.Promise<?>	getObject(TypedTicket typedTicket)
elemental2.promise.Promise<?>	getObject(JsVariableDefinition definition)
elemental2.promise.Promise<JsPartitionedTable>	getPartitionedTable(JsVariableDefinition varDef)
TableReviver	getReviver()
ConfigValue	getServerConfigValue(String key)
elemental2.promise.Promise<?>	getSharedObject(SharedExportBytesUnion sharedExportBytes, String type)
elemental2.promise.Promise<JsTable>	getTable(JsVariableDefinition varDef, Boolean applyPreviewColumns)
Tickets	getTickets()
elemental2.promise.Promise<JsVariableDefinition>	getVariableDefinition(String name, String type)
elemental2.promise.Promise<JsWidget>	getWidget(TypedTicket typedTicket)
elemental2.promise.Promise<JsWidget>	getWidget(JsVariableDefinition varDef)
HierarchicalTableServiceClient	hierarchicalTableServiceClient()
InputTableServiceClient	inputTableServiceClient()
boolean	isUsable()
elemental2.promise.Promise<JsTable>	mergeTables(JsTable[] tables, HasEventHandling failHandler)
BrowserHeaders	metadata()
elemental2.promise.Promise<ClientTableState>	newState(HasEventHandling failHandler, JsTableFetch fetcher, String fetchSummary)
ClientTableState	newState(JsTableFetch fetcher, String fetchSummary)
ClientTableState	newState(ClientTableState from, TableConfig to)
ClientTableState	newState(ClientTableState from, TableConfig to, TableTicket handle)
ClientTableState	newStateFromUnsolicitedTable(ExportedTableCreationResponse unsolicitedTable, String fetchSummary)
elemental2.promise.Promise<JsTable>	newTable(String[] columnNames, String[] types, Object[][] data, String userTimeZone, HasEventHandling failHandler)
ObjectServiceClient	objectServiceClient()
void	onError(Throwable throwable)
void	onOpen(BiConsumer<Void,String> callback)
PartitionedTableServiceClient	partitionedTableServiceClient()
void	registerSimpleReconnectable(HasLifecycle figure)
void	releaseHandle(TableTicket handle)
void	releaseTicket(Ticket ticket)	Releases the ticket, indicating no client using this session will reference it any more.
void	scheduleCheck(ClientTableState state)	Schedules a deferred command to check the given state for active tables.
SessionServiceClient	sessionServiceClient()
void	setSessionTimeoutMs(double sessionTimeoutMs)
elemental2.promise.Promise<SharedExportBytesUnion>	shareObject(ServerObject object, SharedExportBytesUnion sharedTicketBytes)
StorageServiceClient	storageServiceClient()
<ReqT, RespT> BiDiStream.Factory<ReqT,RespT>	streamFactory()
JsRunnable	subscribeToFieldUpdates(JsConsumer<JsVariableChanges> callback)
JsRunnable	subscribeToLogs(JsConsumer<LogItem> callback)
TableServiceClient	tableServiceClient()
elemental2.promise.Promise<JsTable>	timeTable(double periodNanos, DateWrapper startTime)
void	unregisterSimpleReconnectable(HasLifecycle figure)
elemental2.promise.Promise<Object>	whenServerReady(String operationName)

Methods inherited from class java.lang.Object

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

Constructor Details

WorkerConnection

public WorkerConnection(QueryConnectable<?> info)

Method Details

checkStatus

public boolean checkStatus(ResponseStreamWrapper.Status status)

exportedTableUpdateMessage

public void exportedTableUpdateMessage(TableTicket clientId,
 long size)

connectionLost

public void connectionLost()

forceReconnect

@JsMethod
public void forceReconnect()

forceClose

@JsMethod
public void forceClose()

setSessionTimeoutMs

public void setSessionTimeoutMs(double sessionTimeoutMs)

onError

public void onError(Throwable throwable)

getVariableDefinition

public elemental2.promise.Promise<JsVariableDefinition> getVariableDefinition(String name,
 String type)

getTable

public elemental2.promise.Promise<JsTable> getTable(JsVariableDefinition varDef,
 @Nullable
 Boolean applyPreviewColumns)

getObject

public elemental2.promise.Promise<?> getObject(JsVariableDefinition definition)

getJsObject

public elemental2.promise.Promise<?> getJsObject(jsinterop.base.JsPropertyMap<Object> definitionObject)

getObject

public elemental2.promise.Promise<?> getObject(TypedTicket typedTicket)

shareObject

public elemental2.promise.Promise<SharedExportBytesUnion> shareObject(ServerObject object,
 SharedExportBytesUnion sharedTicketBytes)

getSharedObject

public elemental2.promise.Promise<?> getSharedObject(SharedExportBytesUnion sharedExportBytes,
 String type)

subscribeToFieldUpdates

public JsRunnable subscribeToFieldUpdates(JsConsumer<JsVariableChanges> callback)

whenServerReady

public elemental2.promise.Promise<Object> whenServerReady(String operationName)

getPartitionedTable

public elemental2.promise.Promise<JsPartitionedTable> getPartitionedTable(JsVariableDefinition varDef)

getHierarchicalTable

public elemental2.promise.Promise<JsTreeTable> getHierarchicalTable(JsVariableDefinition varDef)

getFigure

public elemental2.promise.Promise<JsFigure> getFigure(JsVariableDefinition varDef)

getWidget

public elemental2.promise.Promise<JsWidget> getWidget(JsVariableDefinition varDef)

getWidget

public elemental2.promise.Promise<JsWidget> getWidget(TypedTicket typedTicket)

registerSimpleReconnectable

public void registerSimpleReconnectable(HasLifecycle figure)

unregisterSimpleReconnectable

public void unregisterSimpleReconnectable(HasLifecycle figure)

tableServiceClient

public TableServiceClient tableServiceClient()

consoleServiceClient

public ConsoleServiceClient consoleServiceClient()

sessionServiceClient

public SessionServiceClient sessionServiceClient()

flightServiceClient

public FlightServiceClient flightServiceClient()

browserFlightServiceClient

public BrowserFlightServiceClient browserFlightServiceClient()

inputTableServiceClient

public InputTableServiceClient inputTableServiceClient()

objectServiceClient

public ObjectServiceClient objectServiceClient()

partitionedTableServiceClient

public PartitionedTableServiceClient partitionedTableServiceClient()

storageServiceClient

public StorageServiceClient storageServiceClient()

configServiceClient

public ConfigServiceClient configServiceClient()

hierarchicalTableServiceClient

public HierarchicalTableServiceClient hierarchicalTableServiceClient()

metadata

public BrowserHeaders metadata()

streamFactory

public <ReqT,
RespT> BiDiStream.Factory<ReqT,RespT> streamFactory()

newTable

public elemental2.promise.Promise<JsTable> newTable(String[] columnNames,
 String[] types,
 Object[][] data,
 String userTimeZone,
 HasEventHandling failHandler)

mergeTables

public elemental2.promise.Promise<JsTable> mergeTables(JsTable[] tables,
 HasEventHandling failHandler)

getBatcher

public RequestBatcher getBatcher(JsTable table)

newStateFromUnsolicitedTable

public ClientTableState newStateFromUnsolicitedTable(ExportedTableCreationResponse unsolicitedTable,
 String fetchSummary)

newState

public ClientTableState newState(JsTableFetch fetcher,
 String fetchSummary)

newState

public elemental2.promise.Promise<ClientTableState> newState(HasEventHandling failHandler,
 JsTableFetch fetcher,
 String fetchSummary)

Parameters:

fetcher - The lambda to perform the fetch of the table's definition.

Returns:

A promise that will resolve when the ClientTableState is RUNNING (and fail if anything goes awry). TODO: consider a fetch timeout.

newState

public ClientTableState newState(ClientTableState from,
 TableConfig to)

newState

public ClientTableState newState(ClientTableState from,
 TableConfig to,
 TableTicket handle)

getCache

public StateCache getCache()

scheduleCheck

public void scheduleCheck(ClientTableState state)

Schedules a deferred command to check the given state for active tables.

releaseHandle

public void releaseHandle(TableTicket handle)

releaseTicket

public void releaseTicket(Ticket ticket)

Releases the ticket, indicating no client using this session will reference it any more.

Parameters:

ticket - the ticket to release

getReviver

public TableReviver getReviver()

isUsable

public boolean isUsable()

getTickets

public Tickets getTickets()

getServerConfigValue

public ConfigValue getServerConfigValue(String key)

onOpen

public void onOpen(BiConsumer<Void,String> callback)

subscribeToLogs

public JsRunnable subscribeToLogs(JsConsumer<LogItem> callback)

dump

@JsMethod
public String dump(@JsOptional
 String graphName)

emptyTable

public elemental2.promise.Promise<JsTable> emptyTable(double size)

timeTable

public elemental2.promise.Promise<JsTable> timeTable(double periodNanos,
 DateWrapper startTime)