WaitAsync Method (Int32, CancellationToken)

SemaphoreSlim.WaitAsync Method (Int32, CancellationToken)

.NET Framework (current version)
 

Asynchronously waits to enter the SemaphoreSlim, using a 32-bit signed integer to measure the time interval, while observing a CancellationToken.

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

public Task<bool> WaitAsync(
	int millisecondsTimeout,
	CancellationToken cancellationToken
)

Parameters

millisecondsTimeout
Type: System.Int32

The number of milliseconds to wait, or Infinite (-1) to wait indefinitely.

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken to observe.

Return Value

Type: System.Threading.Tasks.Task<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.

ObjectDisposedException

The current instance has already been disposed.

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