core/org.gnit.lucenekmp.jdkport/ThreadContainers

ThreadContainers

This class consists exclusively of static methods to support groupings of threads.

Types

abstract class RootContainer : ThreadContainer

Root container that "contains" all platform threads not started in a container. It may include all virtual threads started directly with the Thread API.

Functions

children

fun children(container: ThreadContainer): Sequence<ThreadContainer>

Returns given thread container's "children".

container

fun container(thread: Job): ThreadContainer?

Returns the thread container that the given Thread is in or the root container if not started in a container.

deregisterContainer

fun deregisterContainer(key: Any)

Removes a thread container from being tracked by specifying the key returned when the thread container was registered.

parent

fun parent(container: ThreadContainer): ThreadContainer?

Returns the parent of the given thread container.

registerContainer

fun registerContainer(container: ThreadContainer?): Any

Registers a thread container to be tracked this class, returning a key that is used to remove it from the registry.

root

fun root(): ThreadContainer

Returns the root thread container.

trackAllThreads

fun trackAllThreads(): Boolean

Returns true if all threads are tracked.