core/org.gnit.lucenekmp.jdkport/ThreadContainers/RootContainer

RootContainer

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.

Inheritors

TrackingRootContainer

CountingRootContainer

Constructors

RootContainer

constructor()

Types

CountingRootContainer

class CountingRootContainer : ThreadContainers.RootContainer

Root container that tracks all platform threads and just keeps a count of the virtual threads.

TrackingRootContainer

class TrackingRootContainer : ThreadContainers.RootContainer

Root container that tracks all threads.

Functions

children

fun children(): Sequence<ThreadContainer>

Return the stream of children of this container.

enclosingScope

fun enclosingScope(): StackableScope?

Returns the scope that encloses this scope.

fun <T : StackableScope> enclosingScope(type: KClass<T>): T?

Returns the scope of the given type that encloses this scope.

name

open override fun name(): String

Return the name of this container, may be null.

onExit

open fun onExit(thread: Job)

Invoked when a Thread terminates or starting it fails.

onStart

open fun onStart(thread: Job)

Invoked by Thread::start before the given Thread is started.

owner

open fun owner(): Job?

Returns the scope owner or null if not owned.

parent

open override fun parent(): ThreadContainer?

Returns the parent of this container or null if this is the root container.

popForcefully

suspend fun popForcefully(): Boolean

Pops this scope from the current thread's scope stack.

open override fun previous(): StackableScope?

Returns the scope that directly encloses this scope, null if none.

push

open suspend fun push(): StackableScope

Pushes this scope onto the current thread's scope stack.

threadCount

open fun threadCount(): Long

Return a count of the number of threads in this container.

threads

abstract fun threads(): Sequence<Job>

Returns a stream of the live threads in this container.

toString

open override fun toString(): String

The scoped values captured when the thread container was created.

tryPop

suspend fun tryPop(): Boolean

Pops this scope from the current thread's scope stack if the scope is at the top of stack.