SemaphoreSlim.Wait Method (CancellationToken)

.NET Framework (current version)
 

Blocks the current thread until it can enter the SemaphoreSlim, while observing a CancellationToken.

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

public void Wait(
	CancellationToken cancellationToken
)

Parameters

cancellationToken
Type: System.Threading.CancellationToken

The CancellationToken token to observe.

Exception Condition
OperationCanceledException

cancellationToken was canceled.

ObjectDisposedException

The current instance has already been disposed.

-or-

The CancellationTokenSource that created cancellationToken has already been disposed.

If a thread or task is able to enter the semaphore, it decrements the CurrentCount property by one.

If cancellationToken is cancelled, the thread or task doesn’t enter the semaphore, and the CurrentCount property isn’t decremented. Instead, the method throws an OperationCanceledException exception.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
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: