M_CodeJam_Threading_AsyncLock_AcquireAsync_5

AsyncLock.AcquireAsync Method (TimeSpan, CancellationToken)

Acquires async lock.

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

Syntax

C#

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

VB

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

F#

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

Parameters

 

timeout

Type: System.TimeSpan
A TimeSpan that represents the timeout to wait if lock already acquired, a TimeSpan that represents -1 milliseconds to wait indefinitely, or a TimeSpan that represents 0 milliseconds 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