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

Interface WorkerControl

public interface WorkerControl

Interface for controlling Worker lifecycle.

Method Summary

Modifier and Type	Method	Description
void	cleanupWorkers()	Cleanup any Workers that that were not properly cleaned up from Dispatcher restarts.
Worker	createWorker(WorkerKind workerKind, String workerId, String processInfoId, List<io.deephaven.enterprise.dispatcher.client.WorkerProtocol> protocols, String userName, RemoteProcessingRequest request, File clientClassDirectory, com.fishlib.io.logger.Logger log, ProcessEventLogFormat2Logger processEventLogLogger, String dispatcherHostName, String dispatcherNameForDiscovery, IrisGroupProvider irisGroupProvider, Consumer<String> eventConsumer, Consumer<Worker> workerTerminationCallback)	Construct a Worker with the specified request parameters needed to start the worker.

Method Details

createWorker

Worker createWorker(WorkerKind workerKind,
 String workerId,
 String processInfoId,
 List<io.deephaven.enterprise.dispatcher.client.WorkerProtocol> protocols,
 String userName,
 RemoteProcessingRequest request,
 File clientClassDirectory,
 com.fishlib.io.logger.Logger log,
 ProcessEventLogFormat2Logger processEventLogLogger,
 String dispatcherHostName,
 String dispatcherNameForDiscovery,
 IrisGroupProvider irisGroupProvider,
 @NotNull
 Consumer<String> eventConsumer,
 @NotNull
 Consumer<Worker> workerTerminationCallback)

Construct a Worker with the specified request parameters needed to start the worker. Note: This create method should set up a data object only and not attempt to start or launch the Worker. Use the WorkerControl#startWorkerMethod() to start or launch the Workers

Parameters:

workerKind - WorkerKind for this worker

workerId - A string representing the id for this worker, may not be unique

processInfoId - A unique string representing the worker process

protocols - The protocols implemented by this worker

userName - The username of the requester

request - The RemoteProcessingRequest specifying the processing characteristics

clientClassDirectory - The directory for client classes

log - The logger to use for logging

processEventLogLogger - The process event logger

dispatcherHostName - The dispatcher hostname

dispatcherNameForDiscovery - The dispatcher discovery name

irisGroupProvider - The group provider to allow for getting a user's groups

eventConsumer - A method to be called to propagate any status events upon worker creation

workerTerminationCallback - A method to be called when a worker terminates

Returns:

A Worker data object with attributes and settings of the Worker process

cleanupWorkers

void cleanupWorkers()

Cleanup any Workers that that were not properly cleaned up from Dispatcher restarts. This method should be called when WorkerControl is created.