Table of Contents

IStopToken Interface

Tells a worker that it should wind down.

Remarks

A cancellation token (ICancellationToken, in unit Bcl.Cancellation). Besides waiting on it with WaitFor, a worker can register a callback that wakes up whatever else it blocks on, give up through ThrowIfCancellationRequested, pass it to any API that takes a token, or combine it with a time limit of its own through TCancellationTokenSource.CreateLinked.

Syntax

Unit: Sparkle.Host.Contracts

IStopToken = interface(ICancellationToken);

Methods

Name Description
IsStopRequested Whether a stop has been requested. Same as ICancellation​Token.​IsCancellation​Requested.