Package adams.scripting.engine

Interface MainScriptingEngine

All Superinterfaces:

Destroyable, FlowContextHandler, OptionHandler, Pausable, RemoteCommandProcessorHandler, RemoteScriptingEngine, Stoppable, StoppableWithFeedback

All Known Implementing Classes:

DefaultMainScriptingEngine

public interface MainScriptingEngine
extends RemoteScriptingEngine

Interface for scripting engines that manage worker scripting engines and sending them jobs for execution.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
void	deregisterWorker(Connection conn)	Deregisters a worker with the given connection.
void	killWorkers()	Kills all workers registered.
void	registerWorker(Connection conn)	Registers a worker with the given connection.
String	sendCommand(RemoteCommand cmd)	Sends the command to a worker.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.Pausable

isPaused, pauseExecution, resumeExecution

Methods inherited from interface adams.scripting.processor.RemoteCommandProcessorHandler

getCommandProcessor, setCommandProcessor

Methods inherited from interface adams.scripting.engine.RemoteScriptingEngine

execute, executeJob, getCommandHandler, getFlowContext, getPermissionHandler, getRemoteScriptingEngineHandler, getRequestHandler, getResponseHandler, isRunning, permissionHandlerTipText, requestHandlerTipText, responseHandlerTipText, setCommandHandler, setFlowContext, setPermissionHandler, setRemoteScriptingEngineHandler, setRequestHandler, setResponseHandler

Methods inherited from interface adams.core.Stoppable

stopExecution

Methods inherited from interface adams.core.StoppableWithFeedback

isStopped

Method Detail

registerWorker

void registerWorker(Connection conn)

Registers a worker with the given connection.

Parameters:

conn - the connection of the worker

deregisterWorker

void deregisterWorker(Connection conn)

Deregisters a worker with the given connection.

Parameters:

conn - the connection of the worker

killWorkers

void killWorkers()

Kills all workers registered.

sendCommand

String sendCommand(RemoteCommand cmd)

Sends the command to a worker.

Parameters:

cmd - the command to send

Returns:

null if successful, otherwise error message