com.eclipsesource.v8.utils

Class V8Executor

java.lang.Object

java.lang.Thread

com.eclipsesource.v8.utils.V8Executor

All Implemented Interfaces:

Runnable

public class V8Executor
extends Thread

Executes a JS Script on a new V8 runtime in its own thread, and once finished, will optionally wait on a message queue. If the executor is *not* long running, when the JS Script finishes, the executor will shutdown. If the executor *is* long running, the the script will execute, and when finished, the executor will wait for messages to arrive. When messages arrive, the messageHandler will be invoked with the contents of the message. Executors can be shutdown in two different ways. forceTermination() will stop any executing scripts and immediately terminate the executor. shutdown() will indicate that the executor should shutdown, but this will only happen once any scripts finish executing and the message queue becomes empty.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
V8Executor(String script) Create a new executor and execute the given script on it.
V8Executor(String script, boolean longRunning, String messageHandler) Create a new executor and execute the given script on it.

Method Summary

Methods

Modifier and Type	Method and Description
void	forceTermination() Forces the executor to shutdown immediately.
Exception	getException() Gets the exception that was thrown during the JavaScript execution.
String	getResult() Gets the result of the JavaScript that was executed on this executor.
boolean	hasException() Determines if an exception was thrown during the JavaScript execution.
boolean	hasTerminated() Determines if the executor has terminated.
boolean	isShuttingDown() Returns true if shutdown() or forceTermination() was called to shutdown this executor.
boolean	isTerminating() Returns true if forceTermination was called to shutdown this executor.
void	postMessage(String... message) Posts a message to the receiver to be processed by the executor and sent to the V8 runtime via the messageHandler.
void	run()
protected void	setup(V8 runtime) Override to provide a custom setup for this V8 runtime.
void	shutdown() Indicates to the executor that it should shutdown.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

V8Executor

public V8Executor(String script,
          boolean longRunning,
          String messageHandler)

Create a new executor and execute the given script on it. Once the script has finished executing, the executor can optionally wait on a message queue.

Parameters:

script - The script to execute on this executor.

longRunning - True to indicate that this executor should be longRunning.

messageHandler - The name of the message handler that should be notified when messages are delivered.

V8Executor

public V8Executor(String script)

Create a new executor and execute the given script on it.

Parameters:

script - The script to execute on this executor.

Method Detail

setup

protected void setup(V8 runtime)

Override to provide a custom setup for this V8 runtime. This method can be overridden to configure the V8 runtime, for example, to add callbacks or to add some additional functionality to the global scope.

Parameters:

runtime - The runtime to configure.

getResult

public String getResult()

Gets the result of the JavaScript that was executed on this executor.

Returns:

The result of the JS Script that was executed on this executor.

postMessage

public void postMessage(String... message)

Posts a message to the receiver to be processed by the executor and sent to the V8 runtime via the messageHandler.

Parameters:

message - The message to send to the messageHandler

run

public void run()

Specified by:

run in interface Runnable

Overrides:

run in class Thread

hasException

public boolean hasException()

Determines if an exception was thrown during the JavaScript execution.

Returns:

True if an exception was thrown during the JavaScript execution, false otherwise.

getException

public Exception getException()

Gets the exception that was thrown during the JavaScript execution.

Returns:

The exception that was thrown during the JavaScript execution, or null if no such exception was thrown.

hasTerminated

public boolean hasTerminated()

Determines if the executor has terminated.

Returns:

True if the executor has terminated, false otherwise.

forceTermination

public void forceTermination()

Forces the executor to shutdown immediately. Any currently executing JavaScript will be interrupted and all outstanding messages will be ignored.

shutdown

public void shutdown()

Indicates to the executor that it should shutdown. Any currently executing JavaScript will be allowed to finish, and any outstanding messages will be processed. Only once the message queue is empty, will the executor actually shtutdown.

isShuttingDown

public boolean isShuttingDown()

Returns true if shutdown() or forceTermination() was called to shutdown this executor.

Returns:

True if shutdown() or forceTermination() was called, false otherwise.

isTerminating

public boolean isTerminating()

Returns true if forceTermination was called to shutdown this executor.

Returns:

True if forceTermination() was called, false otherwise.