TaskGroup

Description

sealed class Tinman.Core.Threading.Pooling.TaskGroup

The TaskGroup class represents a group of tasks.

To run all TaskFlags.Synchronized tasks in a group, call RunSynchronized. To cancel the tasks in a group, use Cancel.

public constructor TaskGroup → (1)

name ⁱⁿ : string: [not-empty]
The task group name. This is usually the name of the class that creates the task group.

Creates a new instance of TaskGroup.

[ThreadSafe]
public method Cancel → (1)

wait ⁱⁿ : bool: true to wait for pending group tasks, false to return immediately.

Cancels all queued tasks in this group and optionally waits for all pending ones to terminate.

Upon disposal, this method is called automatically with true being passed to wait ⁱⁿ.

[ThreadSafe]
public method RunSynchronized → ()

returns → bool: true if at least one task has been run, false if there are no pending tasks.

Runs all pending tasks in this given group that are flagged with TaskFlags.Synchronized in the callers thread.

public attribute Monitor → (get)

A synchronization monitor that belongs to this task group.

public attribute Name → (get)

Returns the full name of this task group.