Export (0) Print
Expand All

SemaphoreSlim.Wait Method (TimeSpan, CancellationToken)

Blocks the current thread until it can enter the SemaphoreSlim, using a TimeSpan that specifies the timeout, while observing a CancellationToken.

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

public bool Wait(
	TimeSpan timeout,
	CancellationToken cancellationToken
)

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 to observe.

Return Value

Type: System.Boolean
true if the current thread successfully entered the SemaphoreSlim; otherwise, false.

ExceptionCondition
OperationCanceledException

cancellationToken was canceled.

ArgumentOutOfRangeException

timeout is a negative number other than -1 milliseconds, which represents an infinite time-out -or- timeout is greater than MaxValue.

ObjectDisposedException

The semaphoreSlim instance has been disposed.

-or-

The CancellationTokenSource that created cancellationToken has already been disposed.

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Community Additions

ADD
Show:
© 2014 Microsoft