Click or drag to resize
CancellationTokenSourceExtensionsCancelAfter Method

Namespace: Rackspace.Threading
Assembly: Rackspace.Threading (in Rackspace.Threading.dll) Version: 2.1.0-beta1
Syntax
public static void CancelAfter(
	this CancellationTokenSource cts,
	TimeSpan delay
)

Parameters

cts
Type: System.ThreadingCancellationTokenSource
The CancellationTokenSource to cancel after a delay.
delay
Type: SystemTimeSpan
The time span to wait before canceling the CancellationTokenSource.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type CancellationTokenSource. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
ExceptionCondition
ArgumentNullExceptionIf cts is .
ObjectDisposedExceptionIf cts has been disposed.
ArgumentOutOfRangeExceptionIf the TotalMilliseconds property of delay is less than -1 or greater than MaxValue.
Remarks

If a previous call to this method scheduled a cancellation, the cancellation time is reset to the new delay value. This method has no effect if the CancellationTokenSource has already been canceled (i.e. the IsCancellationRequested property returns .

In all versions of .NET, requesting cancellation of a CancellationTokenSource will not prevent the instance from becoming eligible for garbage collection prior to the timer expiring. In .NET 4 and newer, any associated Timer instance will become eligible for garbage collection at the same time as the associated CancellationTokenSource.

Version Information

.NET for Windows Store apps

Supported in: Windows 8

.NET Framework

Supported in: 4.5, 4.0, 3.5

Portable Class Library

Supported in: Portable Class Library (Legacy), Portable Class Library

Threading Library

Supported in: 2.1, 2.0, 1.1, 1.0
See Also