class TaskGroup in Tinman.Core.Threading.Pooling

Handle object that represents a task group.

sealed class

TaskGroup

extends

Disposable

See also:

ITask.Schedule
ITaskVoid.Schedule

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Monitor

A synchronization monitor that belongs to this task group.

public property	Monitor { get }
type	Monitor
value	[not-null]	The synchronization monitor.

Name

Returns the full name of this task group.

public property	Name { get }
type	string
value	[not-empty]	The full name.

Public / Constructors

TaskGroup

Creates a new instance of TaskGroup.

public constructor	TaskGroup (string name)
params	name	[not-empty]	The task group name. This is usually the name of the class that creates the task group.

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Cancel

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

[ThreadSafe]
public method	Cancel (bool wait)
params	wait		true to wait for pending group tasks, false to return immediately.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

RunSynchronized

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

[ThreadSafe]
public method	RunSynchronized ()
type	bool
returns			true if at least one task has been run, false if there are no pending tasks.

ToString

[Pure]
public override method	ToString ()
type	string