Package com.illumon.iris.db.tables.remotequery

Class QueryDispatcherConnectionImpl

java.lang.Object

com.illumon.iris.db.tables.remotequery.QueryDispatcherConnectionImpl

All Implemented Interfaces:

com.fishlib.dataobjects.HashCommandConstants, RemoteQueryCommandConstants, QueryDispatcherConnection, io.deephaven.enterprise.comm.api.CommandHandler, io.deephaven.enterprise.comm.BaseCommandConstants

public class QueryDispatcherConnectionImpl
extends Object
implements RemoteQueryCommandConstants, io.deephaven.enterprise.comm.api.CommandHandler, QueryDispatcherConnection

Implementation of QueryDispatcherConnection.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QueryDispatcherConnectionImpl.RequestState

Nested classes/interfaces inherited from interface com.illumon.iris.db.tables.remotequery.QueryDispatcherConnection

QueryDispatcherConnection.JobInfo, QueryDispatcherConnection.QueryProcessorRequestHandle

Field Summary

Fields

Modifier and Type	Field	Description
static final long	DISPATCHER_TIMEOUT_MS

Fields inherited from interface io.deephaven.enterprise.comm.BaseCommandConstants

PING, PONG, REGISTER_QUEUE_LISTENER, RESPONSE

Fields inherited from interface com.fishlib.dataobjects.HashCommandConstants

HASHTABLE_CLEAR, HASHTABLE_GET_ALL_ENTRIES, HASHTABLE_GET_KEYS, HASHTABLE_PUT, HASHTABLE_PUTALL, HASHTABLE_REMOVE, HASHTABLE_REMOVEALL, HASHTABLE_SUBSCRIBE, HASHTABLE_UNSUBSCRIBE

Fields inherited from interface com.illumon.iris.db.RemoteQueryCommandConstants

CANCEL_REMOTE_QUERY, CURRENT_HEAP_UPDATE, GET_TABLE_PARTITION_ID, LOG_BUFFER_RECORD, LOG_BUFFER_SUBSCRIPTION, MAXIMUM_HEAP_REQUEST, PROGRESS_UPDATE, REGISTER, REMOTE_QUERY_CONCURRENT, REMOTE_QUERY_DISPATCHER_ADD_JOB, REMOTE_QUERY_DISPATCHER_ADMIN_COMMAND, REMOTE_QUERY_DISPATCHER_CANCEL_JOB, REMOTE_QUERY_DISPATCHER_INFO_FOR_JOB, REMOTE_QUERY_DISPATCHER_PUSH_CLASSES, REMOTE_QUERY_DISPATCHER_THREAD_DUMP, REMOTE_QUERY_FATAL_ERROR, REMOTE_QUERY_GET_SCOPE_VAR, REMOTE_QUERY_METHOD_CALL, REMOTE_QUERY_PREEMPTIVE_TABLE_DELTA, REMOTE_QUERY_PREEMPTIVE_TABLE_SNAPSHOT, REMOTE_QUERY_PREEMPTIVE_TABLE_SUBSCRIPTION, REMOTE_QUERY_PROCESSOR_TERMINATE, REMOTE_QUERY_RELEASE_REFERENCE, REMOTE_QUERY_SERIAL, REMOTE_QUERY_TABLE_ERROR, REMOTE_TABLE_HANDLE_CREATE, REMOTE_TABLE_HANDLE_UPDATE, REMOTE_TABLE_MAP_KEY_ADDITION, REMOTE_TABLE_MAP_RELEASE, RTLM_CREATE_LOGGER, RTLM_DELETE_TABLE, SERVER_INFO_REQUEST, SUBSCRIBE_USAGE_UPDATES

Method Summary

Modifier and Type	Method	Description
static QueryDispatcherConnection	getConnection()
static QueryDispatcherConnection	getConnection(com.fishlib.io.logger.Logger log, String dispatcherHost, int dispatcherPort, io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams)
static QueryDispatcherConnection	getConnection(com.fishlib.io.logger.Logger log, String dispatcherHost, int dispatcherPort, io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams, TokenFactoryFactory tokenAuthenticationManager)
static QueryDispatcherConnection	getConnection(com.fishlib.io.logger.Logger log, String dispatcherHost, int dispatcherPort, io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams, TokenFactoryFactory tokenAuthenticationManager, BiConsumer<io.deephaven.enterprise.comm.api.ClientEntry,com.fishlib.base.Command> commandHandler, Consumer<io.deephaven.enterprise.comm.api.ClientEntry> clientDeathHandler, Consumer<QueryDispatcherConnection> newConnectionConsumer)	Factory method to get a QueryDispatcherConnection for remote queries.
static QueryDispatcherConnection	getConnection(com.fishlib.io.logger.Logger log, String dispatcherHost, int dispatcherPort, io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams, BiConsumer<io.deephaven.enterprise.comm.api.ClientEntry,com.fishlib.base.Command> commandHandler, Consumer<io.deephaven.enterprise.comm.api.ClientEntry> clientDeathHandler, Consumer<QueryDispatcherConnection> newConnectionConsumer)
static QueryDispatcherConnection	getConnection(io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams)
static QueryDispatcherConnection	getConnection(io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams, TokenFactoryFactory tokenAuthenticationManager)
static QueryDispatcherConnection	getConnection(String dispatcherHost, int dispatcherPort)
static QueryDispatcherConnection	getConnection(String dispatcherHost, int dispatcherPort, io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams)
static QueryDispatcherConnection	getConnection(String dispatcherHost, int dispatcherPort, io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams, TokenFactoryFactory tokenAuthenticationManager)
static QueryDispatcherConnection	getConnectionIfAvailable(TokenFactoryFactory tokenAuthenticationManager, String dispatcherHost, int dispatcherPort)	Factory method to get a QueryDispatcherConnection for remote queries.
static QueryDispatcherConnection	getConnectionIfAvailable(String dispatcherHost, int dispatcherPort)
String	getDispatcherHost()
QueryProcessorConnection	getQueryProcessor(boolean addClientClassesToClassPath, List<RemoteQueryClassDefinition> classList, long timeoutMillis)	Gets a query processor assigned by the dispatcher, optionally pushing client classes.
QueryProcessorConnection	getQueryProcessor(QueryDispatcherConnection.QueryProcessorRequestHandle handle, RemoteProcessingRequest request, boolean exportQueryScope, List<RemoteQueryClassDefinition> classList, long timeoutMillis, QueryProcessorConnection.DisconnectHandler disconnectHandler, io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams)	Gets a query processor assigned by the dispatcher, and pushes client classes for use in future queries.
QueryProcessorConnection	getQueryProcessor(QueryDispatcherConnection.QueryProcessorRequestHandle handle, RemoteProcessingRequest request, boolean exportQueryScope, List<RemoteQueryClassDefinition> classList, long timeoutMillis, QueryProcessorConnection.DisconnectHandler disconnectHandler, io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams, TokenFactoryFactory tokenAuthenticationManager)	Gets a query processor assigned by the dispatcher, and pushes client classes for use in future queries.
QueryProcessorConnection	getQueryProcessor(RemoteProcessingRequest request, List<RemoteQueryClassDefinition> classList)	Gets a query processor assigned by the dispatcher, and pushes client classes for use in future queries.
QueryProcessorConnection	getQueryProcessor(RemoteProcessingRequest request, List<RemoteQueryClassDefinition> classList, long timeoutMillis)
QueryDispatcherConnection.QueryProcessorRequestHandle	getQueryProcessorRequestHandle(boolean combineWorkerConnectionStats)	Create a new, single-use handle for use in requesting a new query processor.
QueryDispatcherConnection.QueryProcessorRequestHandle	getQueryProcessorRequestHandle(boolean combineWorkerConnectionStats, Consumer<String> eventConsumer)	Create a new, single-use handle for use in requesting a new query processor.
void	handleClientDeath(io.deephaven.enterprise.comm.api.ClientEntry client)
void	handleCommand(io.deephaven.enterprise.comm.api.ClientEntry client, com.fishlib.base.Command comm)
boolean	isConnected()
void	pushClientClasses(List<RemoteQueryClassDefinition> classList)	Pushes client classes to the dispatcher for use in future queries.
void	release(boolean force)	This optional method allows programs to ensure that no dispatcher CommClient connections remain, if it's called once for the result of every getConnection() invocation.
static void	releaseAll(com.fishlib.io.logger.Logger log, boolean force)
void	requestThreadDump(String workerProcessInfoId, boolean ignoreMissingJob, boolean waitForResponse)
void	sendCancelJob(String workerProcessInfoId, boolean ignoreMissingJob, boolean waitForResponse)
com.fishlib.base.Command	sendCommand(com.fishlib.base.Command command)
QueryDispatcherConnection.JobInfo	sendInfoForJob(String workerProcessInfoId)	Request information about a job the dispatcher may be handling.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.illumon.iris.db.tables.remotequery.QueryDispatcherConnection

getQueryProcessorRequestHandle

Field Details

DISPATCHER_TIMEOUT_MS

public static final long DISPATCHER_TIMEOUT_MS

See Also:

• Constant Field Values

Method Details

sendCommand

public com.fishlib.base.Command sendCommand(com.fishlib.base.Command command)
                                     throws IOException

Specified by:

sendCommand in interface QueryDispatcherConnection

Throws:

IOException

handleCommand

public void handleCommand(io.deephaven.enterprise.comm.api.ClientEntry client,
 com.fishlib.base.Command comm)

Specified by:

handleCommand in interface io.deephaven.enterprise.comm.api.CommandHandler

handleClientDeath

public void handleClientDeath(io.deephaven.enterprise.comm.api.ClientEntry client)

Specified by:

handleClientDeath in interface io.deephaven.enterprise.comm.api.CommandHandler

getDispatcherHost

public String getDispatcherHost()

Specified by:

getDispatcherHost in interface QueryDispatcherConnection

toString

public String toString()

Overrides:

toString in class Object

pushClientClasses

public void pushClientClasses(List<RemoteQueryClassDefinition> classList)
                       throws IOException

Pushes client classes to the dispatcher for use in future queries.

Specified by:

pushClientClasses in interface QueryDispatcherConnection

Parameters:

classList - the classes to be pushed

Throws:

IOException - from the socket operations

getQueryProcessorRequestHandle

public QueryDispatcherConnection.QueryProcessorRequestHandle getQueryProcessorRequestHandle(boolean combineWorkerConnectionStats)

Description copied from interface: QueryDispatcherConnection

Create a new, single-use handle for use in requesting a new query processor.

Specified by:

getQueryProcessorRequestHandle in interface QueryDispatcherConnection

Parameters:

combineWorkerConnectionStats - if true, use one set of statistics items for the worker connection statistics, rather than a different set of items for each worker connection

Returns:

A new, single-use handle for use in requesting a new query processor.

getQueryProcessorRequestHandle

public QueryDispatcherConnection.QueryProcessorRequestHandle getQueryProcessorRequestHandle(boolean combineWorkerConnectionStats,
 @NotNull
 Consumer<String> eventConsumer)

Description copied from interface: QueryDispatcherConnection

Create a new, single-use handle for use in requesting a new query processor.

Specified by:

getQueryProcessorRequestHandle in interface QueryDispatcherConnection

Parameters:

combineWorkerConnectionStats - if true, use one set of statistics items for the worker connection statistics, rather than a different set of items for each worker connection

eventConsumer - Function that takes a string to allow logging detailed status updates upon worker startup.

Returns:

A new, single-use handle for use in requesting a new query processor.

getQueryProcessor

public QueryProcessorConnection getQueryProcessor(QueryDispatcherConnection.QueryProcessorRequestHandle handle,
 RemoteProcessingRequest request,
 boolean exportQueryScope,
 List<RemoteQueryClassDefinition> classList,
 long timeoutMillis,
 @Nullable
 QueryProcessorConnection.DisconnectHandler disconnectHandler,
 @Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams,
 @NotNull
 TokenFactoryFactory tokenAuthenticationManager)
                                           throws RemoteQueryException

Gets a query processor assigned by the dispatcher, and pushes client classes for use in future queries.

Specified by:

getQueryProcessor in interface QueryDispatcherConnection

Parameters:

handle -

request -

exportQueryScope -

classList -

timeoutMillis - How long to wait for the job to be scheduled and the processor to be assigned. <= 0 means practically forever.

disconnectHandler -

connectionMonitorParams -

tokenAuthenticationManager -

Returns:

Throws:

RemoteQueryException

getQueryProcessor

public QueryProcessorConnection getQueryProcessor(QueryDispatcherConnection.QueryProcessorRequestHandle handle,
 RemoteProcessingRequest request,
 boolean exportQueryScope,
 List<RemoteQueryClassDefinition> classList,
 long timeoutMillis,
 @Nullable
 QueryProcessorConnection.DisconnectHandler disconnectHandler,
 @Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams)
                                           throws RemoteQueryException

Gets a query processor assigned by the dispatcher, and pushes client classes for use in future queries.

Specified by:

getQueryProcessor in interface QueryDispatcherConnection

Parameters:

handle -

request -

classList -

timeoutMillis - How long to wait for the job to be scheduled and the processor to be assigned. <= 0 means practically forever.

disconnectHandler -

connectionMonitorParams -

Returns:

A new QueryProcessorConnection

Throws:

RemoteQueryException

getQueryProcessor

public QueryProcessorConnection getQueryProcessor(boolean addClientClassesToClassPath,
 List<RemoteQueryClassDefinition> classList,
 long timeoutMillis)
                                           throws RemoteQueryException

Gets a query processor assigned by the dispatcher, optionally pushing client classes. This method will create a RemoteProcessingRequest and automatically retry authentication with different origins if a failure occurs

Specified by:

getQueryProcessor in interface QueryDispatcherConnection

Throws:

RemoteQueryException

See Also:

• getQueryProcessor(QueryProcessorRequestHandle, RemoteProcessingRequest, boolean, List, long, QueryProcessorConnection.DisconnectHandler, ConnectionMonitor.Params)

getQueryProcessor

public QueryProcessorConnection getQueryProcessor(RemoteProcessingRequest request,
 List<RemoteQueryClassDefinition> classList,
 long timeoutMillis)
                                           throws RemoteQueryException

Specified by:

getQueryProcessor in interface QueryDispatcherConnection

Throws:

RemoteQueryException

getQueryProcessor

public QueryProcessorConnection getQueryProcessor(RemoteProcessingRequest request,
 List<RemoteQueryClassDefinition> classList)
                                           throws RemoteQueryException

Gets a query processor assigned by the dispatcher, and pushes client classes for use in future queries. Uses default timeout (1 week, effectively infinite).

Specified by:

getQueryProcessor in interface QueryDispatcherConnection

Parameters:

request - the remote processing request

classList - the classes to be pushed

Returns:

the QueryProcessorConnection

Throws:

RemoteQueryException

isConnected

public boolean isConnected()

Specified by:

isConnected in interface QueryDispatcherConnection

Returns:

The internal CommClient's connection status.

release

public void release(boolean force)
             throws IOException

This optional method allows programs to ensure that no dispatcher CommClient connections remain, if it's called once for the result of every getConnection() invocation. Calling it more than once per getConnection() will result in unexpectedly disconnected clients.

Specified by:

release in interface QueryDispatcherConnection

Parameters:

force - force a disconnection even if the reference count is not zero

Throws:

IOException - from the socket calls

sendInfoForJob

public QueryDispatcherConnection.JobInfo sendInfoForJob(String workerProcessInfoId)
                                                 throws RemoteQueryException

Description copied from interface: QueryDispatcherConnection

Request information about a job the dispatcher may be handling.

Specified by:

sendInfoForJob in interface QueryDispatcherConnection

Parameters:

workerProcessInfoId - the worker process info id for the job

Returns:

A JobInfo object with the information requested; note that if the job does not exist that is not an error.

Throws:

RemoteQueryException - if retrieving the information failed.

sendCancelJob

public void sendCancelJob(String workerProcessInfoId,
 boolean ignoreMissingJob,
 boolean waitForResponse)
                   throws RemoteQueryException

Specified by:

sendCancelJob in interface QueryDispatcherConnection

Throws:

RemoteQueryException

requestThreadDump

public void requestThreadDump(String workerProcessInfoId,
 boolean ignoreMissingJob,
 boolean waitForResponse)
                       throws RemoteQueryException

Specified by:

requestThreadDump in interface QueryDispatcherConnection

Throws:

RemoteQueryException

releaseAll

public static void releaseAll(com.fishlib.io.logger.Logger log,
 boolean force)

getConnection

public static QueryDispatcherConnection getConnection()
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(@Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams)
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(@Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams,
 @NotNull
 TokenFactoryFactory tokenAuthenticationManager)
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(String dispatcherHost,
 int dispatcherPort)
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(String dispatcherHost,
 int dispatcherPort,
 @Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams)
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(String dispatcherHost,
 int dispatcherPort,
 @Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams,
 @NotNull
 TokenFactoryFactory tokenAuthenticationManager)
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(com.fishlib.io.logger.Logger log,
 String dispatcherHost,
 int dispatcherPort,
 @Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams)
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(com.fishlib.io.logger.Logger log,
 String dispatcherHost,
 int dispatcherPort,
 @Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams,
 @Nullable
 BiConsumer<io.deephaven.enterprise.comm.api.ClientEntry,com.fishlib.base.Command> commandHandler,
 @Nullable
 Consumer<io.deephaven.enterprise.comm.api.ClientEntry> clientDeathHandler,
 @Nullable
 Consumer<QueryDispatcherConnection> newConnectionConsumer)
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(com.fishlib.io.logger.Logger log,
 String dispatcherHost,
 int dispatcherPort,
 @Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams,
 @NotNull
 TokenFactoryFactory tokenAuthenticationManager)
                                               throws IOException

Throws:

IOException

getConnection

public static QueryDispatcherConnection getConnection(com.fishlib.io.logger.Logger log,
 String dispatcherHost,
 int dispatcherPort,
 @Nullable
 io.deephaven.enterprise.comm.ConnectionMonitor.Params connectionMonitorParams,
 @NotNull
 TokenFactoryFactory tokenAuthenticationManager,
 @Nullable
 BiConsumer<io.deephaven.enterprise.comm.api.ClientEntry,com.fishlib.base.Command> commandHandler,
 @Nullable
 Consumer<io.deephaven.enterprise.comm.api.ClientEntry> clientDeathHandler,
 @Nullable
 Consumer<QueryDispatcherConnection> newConnectionConsumer)
                                               throws IOException

Factory method to get a QueryDispatcherConnection for remote queries. See release() for connection cleanup, if desired.

Parameters:

log - the log

dispatcherHost - the dispatcher's host

dispatcherPort - the dispatcher's port

connectionMonitorParams - the connection monitor parameters

tokenAuthenticationManager - an authentication client manager

commandHandler - if provided, a consumer to be called when a command is sent by the dispatcher

clientDeathHandler - if provided, a consumer to be called when the dispatcher dies

newConnectionConsumer - if provided, a consumer to be called if a new connection is established

Returns:

A new connection if none is cached for the host/port pair provided, or the cached connection

Throws:

IOException - from the socket calls

ImplNote:

If the connection already existed then the commandHandler and clientDeathHandler will not be attached.

getConnectionIfAvailable

public static QueryDispatcherConnection getConnectionIfAvailable(TokenFactoryFactory tokenAuthenticationManager,
 String dispatcherHost,
 int dispatcherPort)

Factory method to get a QueryDispatcherConnection for remote queries. See release() for connection cleanup, if desired.

Parameters:

dispatcherHost - the dispatcher's host

dispatcherPort - the dispatcher's port

Returns:

The cached connection if one is available and connected, or null if none is available

getConnectionIfAvailable

public static QueryDispatcherConnection getConnectionIfAvailable(String dispatcherHost,
 int dispatcherPort)