com.oracle.truffle.api.vm

Class PolyglotRuntime

java.lang.Object

com.oracle.truffle.api.vm.PolyglotRuntime

public final class PolyglotRuntime
extends Object

A runtime environment for one or more PolyglotEngine instances. By default a constructed PolyglotEngine provides data and code isolation. However, if the same runtime is used to construct multiple engines then code can be shared between them. Languages can also decide to share immutable parts of their data between engines of a runtime. As a consequence memory consumption for an engine is expected to be lower if they are constructed with the same runtime. Methods of PolyglotRuntime can be safely used from multiple-threads. Usage:

PolyglotRuntime runtime = PolyglotRuntime.newBuilder().
                setOut(out).setErr(err).build();

PolyglotEngine.Builder builder = PolyglotEngine.newBuilder().
                runtime(runtime);
PolyglotEngine engine1 = builder.build();
PolyglotEngine engine2 = builder.build();
PolyglotEngine engine3 = builder.build();

The above example prepares three engines that share the runtime.

Since:

0.25

See Also:

PolyglotEngine, More information for language implementors.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PolyglotRuntime.Builder Builder for creating new instance of a PolyglotRuntime.
class	PolyglotRuntime.Instrument A handle for an instrument installed in the runtime, usable from other threads, that can observe and inject behavior into language execution.

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes the runtime and with it all created instruments.
Map<String,? extends PolyglotRuntime.Instrument>	getInstruments() Gets the map: Instrument ID --> PolyglotRuntime.Instrument loaded in this runtime, whether the instrument is enabled or not.
static PolyglotRuntime.Builder	newBuilder() Starts creation of a new runtime instance.

Methods inherited from class java.lang.Object

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

Method Detail

getInstruments

public Map<String,? extends PolyglotRuntime.Instrument> getInstruments()

Gets the map: Instrument ID --> PolyglotRuntime.Instrument loaded in this runtime, whether the instrument is enabled or not.

Returns:

map of currently loaded instruments

Since:

0.25

dispose

public void dispose()

Disposes the runtime and with it all created instruments. Throws IllegalStateException if not all engines created using this runtime are not yet disposed. Default/private runtimes of an engine are disposed automatically with the engine.

Since:

0.25

newBuilder

public static PolyglotRuntime.Builder newBuilder()

Starts creation of a new runtime instance. Call any methods of the PolyglotRuntime.Builder and finish the creation by calling PolyglotRuntime.Builder.build().

Returns:

new instance of a builder

Since:

0.25