WaitAsync Method (TimeSpan, CancellationToken)

SemaphoreSlim.WaitAsync Method (TimeSpan, CancellationToken)

.NET Framework (current version)
 

Asynchronously waits to enter the SemaphoreSlim, using a TimeSpan to measure the time interval, while observing a CancellationToken.

Namespace:   System.Threading
Assembly:  mscorlib (in mscorlib.dll)

Public Function WaitAsync (
	timeout As TimeSpan,
	cancellationToken As CancellationToken
) As Task(Of Boolean)

Parameters

timeout
Type: System.TimeSpan

A TimeSpan that represents the number of milliseconds to wait, or a TimeSpan that represents -1 milliseconds to wait indefinitely.

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken token to observe.

Return Value

Type: System.Threading.Tasks.Task(Of Boolean)

A task that will complete with a result of true if the current thread successfully entered the SemaphoreSlim, otherwise with a result of false.

Exception Condition
ArgumentOutOfRangeException

millisecondsTimeout is a negative number other than -1, which represents an infinite time-out

-or-

timeout is greater than MaxValue.

OperationCanceledException

cancellationToken was canceled.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft