Modifier and Type	Class and Description
public static class	Isolates.CreateIsolateParameters Parameters for the creation of an isolate.
public static class	Isolates.IsolateException An exception thrown in the context of managing isolates.
public static interface	Isolates.ProtectionDomain Identifies a protection domain for an isolate.

Access	Constructor and Description
private	Isolates()

Method Summary

Modifier and Type	Method and Description
public static IsolateThread	Returns: A pointer to the structure representing the newly attached isolate thread. attachCurrentThread(Isolate The isolate to which to attach the current thread. isolate) Attaches the current thread to the passed isolate.
public static IsolateThread	Returns: A pointer to the structure that represents the current thread in the new isolate. createIsolate(Isolates.CreateIsolateParameters Parameters for the creation of the isolate. parameters) Creates a new isolate with the passed parameters.
public static void	detachThread(IsolateThread The isolate thread to detach from its isolate. thread) Detaches the passed isolate thread from its isolate and discards any state or context that is associated with it.
public static IsolateThread	Returns: A pointer to the current thread's structure in the specified isolate or `null` if the thread is not attached to that isolate. getCurrentThread(Isolate The isolate for which to retrieve the current thread's corresponding structure isolate) Given an isolate to which the current thread is attached, returns the address of the thread's associated isolate thread structure.
public static Isolate	Returns: A pointer to the isolate, or `null`. getIsolate(IsolateThread The isolate thread for which to retrieve the isolate. thread) Given an isolate thread structure, determines to which isolate it belongs and returns the address of the isolate structure.
public static void	tearDownIsolate(IsolateThread `IsolateThread` of the current thread that is attached to the isolate which is to be torn down. thread) Tears down an isolate.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Isolates	back to summary
private Isolates()

Method Detail

attachCurrentThread	back to summary
public static IsolateThread attachCurrentThread(Isolate isolate) throws IsolateException Attaches the current thread to the passed isolate. If the thread has already been attached, the call provides the thread's existing isolate thread structure. Parameters isolate:Isolate The isolate to which to attach the current thread. Returns:IsolateThread A pointer to the structure representing the newly attached isolate thread. Exceptions IsolateException: on error. Since 19.0

attachCurrentThread

back to summary

public static IsolateThread attachCurrentThread(Isolate isolate) throws IsolateException

Attaches the current thread to the passed isolate. If the thread has already been attached, the call provides the thread's existing isolate thread structure.

Parameters

isolate:Isolate: The isolate to which to attach the current thread.

Returns:IsolateThread

A pointer to the structure representing the newly attached isolate thread.

Exceptions

IsolateException:: on error.

Since

19.0

createIsolate back to summary

createIsolate	back to summary
public static IsolateThread createIsolate(Isolates.CreateIsolateParameters parameters) throws IsolateException Creates a new isolate with the passed parameters. On success, the current thread is attached to the created isolate, and a pointer to its associated `IsolateThread` structure is returned. Parameters parameters:Isolates.CreateIsolateParameters Parameters for the creation of the isolate. Returns:IsolateThread A pointer to the structure that represents the current thread in the new isolate. Exceptions IsolateException: on error. Since 19.0

public static IsolateThread createIsolate(Isolates.CreateIsolateParameters parameters) throws IsolateException

Creates a new isolate with the passed parameters. On success, the current thread is attached to the created isolate, and a pointer to its associated IsolateThread structure is returned.

Parameters

parameters:Isolates.CreateIsolateParameters: Parameters for the creation of the isolate.

Returns:IsolateThread

A pointer to the structure that represents the current thread in the new isolate.

Exceptions

IsolateException:: on error.

Since

19.0

detachThread	back to summary
public static void detachThread(IsolateThread thread) throws IsolateException Detaches the passed isolate thread from its isolate and discards any state or context that is associated with it. At the time of the call, no code may still be executing in the isolate thread's context. The passed pointer is no longer valid after the method returns. Parameters thread:IsolateThread The isolate thread to detach from its isolate. Exceptions IsolateException: on error. Since 19.0

detachThread

back to summary

public static void detachThread(IsolateThread thread) throws IsolateException

Detaches the passed isolate thread from its isolate and discards any state or context that is associated with it. At the time of the call, no code may still be executing in the isolate thread's context. The passed pointer is no longer valid after the method returns.

Parameters

thread:IsolateThread: The isolate thread to detach from its isolate.

Exceptions

IsolateException:: on error.

Since

19.0

getCurrentThread back to summary

getCurrentThread	back to summary
public static IsolateThread getCurrentThread(Isolate isolate) throws IsolateException Given an isolate to which the current thread is attached, returns the address of the thread's associated isolate thread structure. If the current thread is not attached to the passed isolate, returns `null`. Parameters isolate:Isolate The isolate for which to retrieve the current thread's corresponding structure Returns:IsolateThread A pointer to the current thread's structure in the specified isolate or `null` if the thread is not attached to that isolate. Exceptions IsolateException: on error. Since 19.0

public static IsolateThread getCurrentThread(Isolate isolate) throws IsolateException

Given an isolate to which the current thread is attached, returns the address of the thread's associated isolate thread structure. If the current thread is not attached to the passed isolate, returns null.

Parameters

isolate:Isolate: The isolate for which to retrieve the current thread's corresponding structure

Returns:IsolateThread

A pointer to the current thread's structure in the specified isolate or null if the thread is not attached to that isolate.

Exceptions

IsolateException:: on error.

Since

19.0

getIsolate back to summary

getIsolate	back to summary
public static Isolate getIsolate(IsolateThread thread) throws IsolateException Given an isolate thread structure, determines to which isolate it belongs and returns the address of the isolate structure. May return `null` if the specified isolate thread structure is no longer valid. Parameters thread:IsolateThread The isolate thread for which to retrieve the isolate. Returns:Isolate A pointer to the isolate, or `null`. Exceptions IsolateException: on error. Since 19.0

public static Isolate getIsolate(IsolateThread thread) throws IsolateException

Given an isolate thread structure, determines to which isolate it belongs and returns the address of the isolate structure. May return null if the specified isolate thread structure is no longer valid.

Parameters

thread:IsolateThread: The isolate thread for which to retrieve the isolate.

Returns:Isolate

A pointer to the isolate, or null.

Exceptions

IsolateException:: on error.

Since

19.0

tearDownIsolate back to summary

tearDownIsolate	back to summary
public static void tearDownIsolate(IsolateThread thread) throws IsolateException Tears down an isolate. Given an `IsolateThread` for the current thread which must be attached to the isolate to be torn down, waits for any other attached threads to detach from the isolate, then discards the isolate's objects, threads, and any other state or context that is associated with it. The passed pointer is no longer valid after the method returns. Parameters thread:IsolateThread `IsolateThread` of the current thread that is attached to the isolate which is to be torn down. Exceptions IsolateException: on error. Since 19.0

public static void tearDownIsolate(IsolateThread thread) throws IsolateException

Tears down an isolate. Given an IsolateThread for the current thread which must be attached to the isolate to be torn down, waits for any other attached threads to detach from the isolate, then discards the isolate's objects, threads, and any other state or context that is associated with it. The passed pointer is no longer valid after the method returns.

Parameters

thread:IsolateThread: IsolateThread of the current thread that is attached to the isolate which is to be torn down.

Exceptions

IsolateException:: on error.

Since

19.0

org.graalvm.nativeimage back to summary

public final Class Isolates.CreateIsolateParameters

Class Inheritance

extends Object

java.lang.Object
org.graalvm.nativeimage.Isolates.CreateIsolateParameters

Parameters for the creation of an isolate.

Since: 19.0
See Also: CreateIsolateParameters.Builder

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Isolates.CreateIsolateParameters.Builder Builder for a `CreateIsolateParameters` instance.

Field Summary

Modifier and Type	Field and Description
private final List<String>	arguments
private final String	auxiliaryImagePath
private final UnsignedWord	auxiliaryImageReservedSpaceSize
private static final Isolates.CreateIsolateParameters	DEFAULT
private final Isolates.ProtectionDomain	protectionDomain
private final UnsignedWord	reservedAddressSpaceSize

Constructor Summary

Access	Constructor and Description
private	CreateIsolateParameters(UnsignedWord reservedAddressSpaceSize, String auxiliaryImagePath, UnsignedWord auxiliaryImageReservedSpaceSize, List<String> arguments, Isolates.ProtectionDomain protectionDomain)

Method Summary

Modifier and Type	Method and Description
public List<String>	getArguments() Returns the list of additional isolate arguments.
public String	getAuxiliaryImagePath() Returns the file path to an auxiliary image which should be loaded in addition to the main image, or `null` if no such image should be loaded.
public UnsignedWord	getAuxiliaryImageReservedSpaceSize() Returns the size in bytes of an address space to reserve for loading an auxiliary image in addition to the main image, or 0 if no space should be reserved.
public static Isolates.CreateIsolateParameters	getDefault() Returns a `CreateIsolateParameters` with all default values.
public Isolates.ProtectionDomain	getProtectionDomain() Returns the memory protection domain to be used for an isolate.
public UnsignedWord	getReservedAddressSpaceSize() Returns the size in bytes for the reserved virtual address space of the new isolate.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

arguments	back to summary
private final List<String> arguments

auxiliaryImagePath	back to summary
private final String auxiliaryImagePath

auxiliaryImageReservedSpaceSize	back to summary
private final UnsignedWord auxiliaryImageReservedSpaceSize

DEFAULT	back to summary
private static final Isolates.CreateIsolateParameters DEFAULT

protectionDomain	back to summary
private final Isolates.ProtectionDomain protectionDomain

reservedAddressSpaceSize	back to summary
private final UnsignedWord reservedAddressSpaceSize

Constructor Detail

CreateIsolateParameters	back to summary
private CreateIsolateParameters(UnsignedWord reservedAddressSpaceSize, String auxiliaryImagePath, UnsignedWord auxiliaryImageReservedSpaceSize, List<String> arguments, Isolates.ProtectionDomain protectionDomain)

Method Detail

getArguments	back to summary
public List<String> getArguments() Returns the list of additional isolate arguments. Since 22.1

getArguments

back to summary

public List<String> getArguments()

Returns the list of additional isolate arguments.

Since: 22.1

getAuxiliaryImagePath back to summary

getAuxiliaryImagePath	back to summary
public String getAuxiliaryImagePath() Returns the file path to an auxiliary image which should be loaded in addition to the main image, or `null` if no such image should be loaded. Since 20.1

public String getAuxiliaryImagePath()

Returns the file path to an auxiliary image which should be loaded in addition to the main image, or null if no such image should be loaded.

Since: 20.1

getAuxiliaryImageReservedSpaceSize	back to summary
public UnsignedWord getAuxiliaryImageReservedSpaceSize() Returns the size in bytes of an address space to reserve for loading an auxiliary image in addition to the main image, or 0 if no space should be reserved. Since 20.1

getAuxiliaryImageReservedSpaceSize

back to summary

public UnsignedWord getAuxiliaryImageReservedSpaceSize()

Returns the size in bytes of an address space to reserve for loading an auxiliary image in addition to the main image, or 0 if no space should be reserved.

Since: 20.1

getDefault back to summary

getDefault	back to summary
public static Isolates.CreateIsolateParameters getDefault() Returns a `CreateIsolateParameters` with all default values. Since 19.0

public static Isolates.CreateIsolateParameters getDefault()

Returns a CreateIsolateParameters with all default values.

Since: 19.0

getProtectionDomain	back to summary
public Isolates.ProtectionDomain getProtectionDomain() Returns the memory protection domain to be used for an isolate. Since 22.1

getProtectionDomain

back to summary

public Isolates.ProtectionDomain getProtectionDomain()

Returns the memory protection domain to be used for an isolate.

Since: 22.1

getReservedAddressSpaceSize	back to summary
public UnsignedWord getReservedAddressSpaceSize() Returns the size in bytes for the reserved virtual address space of the new isolate. Since 19.0

getReservedAddressSpaceSize

back to summary

public UnsignedWord getReservedAddressSpaceSize()

Returns the size in bytes for the reserved virtual address space of the new isolate.

Since: 19.0

org.graalvm.nativeimage back to summary

public final Class Isolates.CreateIsolateParameters.Builder

Class Inheritance

extends Object

java.lang.Object
org.graalvm.nativeimage.Isolates.CreateIsolateParameters.Builder

Builder for a CreateIsolateParameters instance.

Since: 19.0

Field Summary

Modifier and Type	Field and Description
private final List<String>	arguments
private String	auxiliaryImagePath
private UnsignedWord	auxiliaryImageReservedSpaceSize
private Isolates.ProtectionDomain	protectionDomain
private UnsignedWord	reservedAddressSpaceSize

Constructor Summary

Access	Constructor and Description
public	Builder() Creates a new builder with default values.

Method Summary

Modifier and Type	Method and Description
public Isolates.CreateIsolateParameters.Builder	appendArgument(String argument) Appends an isolate argument.
public Isolates.CreateIsolateParameters.Builder	auxiliaryImagePath(String filePath) Sets the file path to an auxiliary image which should be loaded in addition to the main image, or `null` if no such image should be loaded.
public Isolates.CreateIsolateParameters.Builder	auxiliaryImageReservedSpaceSize(UnsignedWord size) Sets the size in bytes of an address space to reserve for loading an auxiliary image in addition to the main image, or 0 if no space should be reserved.
public Isolates.CreateIsolateParameters	build() Produces the final `CreateIsolateParameters` with the values set previously by the builder methods.
public Isolates.CreateIsolateParameters.Builder	reservedAddressSpaceSize(UnsignedWord size) Sets the size in bytes for the reserved virtual address space of the new isolate.
public Isolates.CreateIsolateParameters.Builder	setProtectionDomain(Isolates.ProtectionDomain domain) Sets the `ProtectionDomain` for an isolate.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

arguments	back to summary
private final List<String> arguments

auxiliaryImagePath	back to summary
private String auxiliaryImagePath

auxiliaryImageReservedSpaceSize	back to summary
private UnsignedWord auxiliaryImageReservedSpaceSize

protectionDomain	back to summary
private Isolates.ProtectionDomain protectionDomain

reservedAddressSpaceSize	back to summary
private UnsignedWord reservedAddressSpaceSize

Constructor Detail

Builder	back to summary
public Builder() Creates a new builder with default values. Since 19.0

Builder

back to summary

public Builder()

Creates a new builder with default values.

Since: 19.0

Method Detail

appendArgument back to summary

appendArgument	back to summary
public Isolates.CreateIsolateParameters.Builder appendArgument(String argument) Appends an isolate argument. The syntax for arguments is the same as the one that is used on the command-line when starting Native Image (e.g., `-XX:+AutomaticReferenceHandling`). If the same argument is added multiple times, the last specified value will be used. Since 22.1

public Isolates.CreateIsolateParameters.Builder appendArgument(String argument)

Appends an isolate argument. The syntax for arguments is the same as the one that is used on the command-line when starting Native Image (e.g., -XX:+AutomaticReferenceHandling). If the same argument is added multiple times, the last specified value will be used.

Since: 22.1

auxiliaryImagePath back to summary

auxiliaryImagePath	back to summary
public Isolates.CreateIsolateParameters.Builder auxiliaryImagePath(String filePath) Sets the file path to an auxiliary image which should be loaded in addition to the main image, or `null` if no such image should be loaded. Since 20.1

public Isolates.CreateIsolateParameters.Builder auxiliaryImagePath(String filePath)

Sets the file path to an auxiliary image which should be loaded in addition to the main image, or null if no such image should be loaded.

Since: 20.1

auxiliaryImageReservedSpaceSize	back to summary
public Isolates.CreateIsolateParameters.Builder auxiliaryImageReservedSpaceSize(UnsignedWord size) Sets the size in bytes of an address space to reserve for loading an auxiliary image in addition to the main image, or 0 if no space should be reserved. Since 20.1

auxiliaryImageReservedSpaceSize

back to summary

public Isolates.CreateIsolateParameters.Builder auxiliaryImageReservedSpaceSize(UnsignedWord size)

Sets the size in bytes of an address space to reserve for loading an auxiliary image in addition to the main image, or 0 if no space should be reserved.

Since: 20.1

build back to summary

build	back to summary
public Isolates.CreateIsolateParameters build() Produces the final `CreateIsolateParameters` with the values set previously by the builder methods. Since 19.0

public Isolates.CreateIsolateParameters build()

Produces the final CreateIsolateParameters with the values set previously by the builder methods.

Since: 19.0

reservedAddressSpaceSize	back to summary
public Isolates.CreateIsolateParameters.Builder reservedAddressSpaceSize(UnsignedWord size) Sets the size in bytes for the reserved virtual address space of the new isolate. Since 19.0

reservedAddressSpaceSize

back to summary

public Isolates.CreateIsolateParameters.Builder reservedAddressSpaceSize(UnsignedWord size)

Sets the size in bytes for the reserved virtual address space of the new isolate.

Since: 19.0

setProtectionDomain back to summary

setProtectionDomain	back to summary
public Isolates.CreateIsolateParameters.Builder setProtectionDomain(Isolates.ProtectionDomain domain) Sets the `ProtectionDomain` for an isolate. Since 22.1

public Isolates.CreateIsolateParameters.Builder setProtectionDomain(Isolates.ProtectionDomain domain)

Sets the ProtectionDomain for an isolate.

Since: 22.1

Modifier and Type	Field and Description
public static final Isolates.ProtectionDomain	NEW_DOMAIN Creates a new protection domain if passed to the `CreateIsolateParameters.Builder`.
public static final Isolates.ProtectionDomain	NO_DOMAIN Do not use a protection domain.

public final Class Isolates

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Class Isolates.CreateIsolateParameters

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Isolates.CreateIsolateParameters.Builder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class Isolates.IsolateException

Field Summary

Constructor Summary

Field Detail

Constructor Detail

public Interface Isolates.ProtectionDomain

Field Summary

Field Detail