M_CodeJam_Threading_AsyncLock_AcquireAsync_2

AsyncLock.AcquireAsync Method (Int32, CancellationToken)

Acquires async lock.

Namespace: CodeJam.Threading
Assembly: CodeJam (in CodeJam.dll) Version: 2.1.0.0

Syntax

C#

public Task<IDisposable> AcquireAsync(
	int timeout,
	CancellationToken cancellation
)

VB

Public Function AcquireAsync ( 
	timeout As Integer,
	cancellation As CancellationToken
) As Task(Of IDisposable)

F#

member AcquireAsync : 
        timeout : int * 
        cancellation : CancellationToken -> Task<IDisposable> 

Parameters

 

timeout

Type: System.Int32
A number of milliseconds that represents the timeout to wait if lock already acquired, a -1 to wait indefinitely, or a 0 to return immediately.

cancellation

Type: System.Threading.CancellationToken
The CancellationToken token to observe.

Return Value

Type: Task(IDisposable)
A task that returns IDisposable to release the lock.

Exceptions

 

Exception	Condition
OperationCanceledException	The token has had cancellation requested.
TimeoutException	The timeout has expired.

See Also

Reference

AsyncLock Class
AcquireAsync Overload
CodeJam.Threading Namespace