Class AsyncExclusiveLock

Represents asynchronous mutually exclusive lock.

Inheritance
Object
Disposable
QueuedSynchronizer
AsyncExclusiveLock
Implements
IAsyncDisposable
Inherited Members
Namespace: DotNext.Threading
Assembly: DotNext.Threading.dll
Syntax
public class AsyncExclusiveLock : QueuedSynchronizer

Constructors

| Improve this Doc View Source

AsyncExclusiveLock()

Initializes a new asynchronous exclusive lock.

Declaration
public AsyncExclusiveLock()
| Improve this Doc View Source

AsyncExclusiveLock(Int32)

Initializes a new asynchronous exclusive lock.

Declaration
public AsyncExclusiveLock(int concurrencyLevel)
Parameters
Type Name Description
Int32 concurrencyLevel

The expected number of concurrent flows.

Properties

| Improve this Doc View Source

IsLockHeld

Indicates that exclusive lock taken.

Declaration
public bool IsLockHeld { get; }
Property Value
Type Description
Boolean

Methods

| Improve this Doc View Source

AcquireAsync(CancellationToken)

Enters the lock in exclusive mode asynchronously.

Declaration
public ValueTask AcquireAsync(CancellationToken token = null)
Parameters
Type Name Description
CancellationToken token

The token that can be used to abort lock acquisition.
Returns
Type Description
ValueTask

The task representing lock acquisition operation.
| Improve this Doc View Source

AcquireAsync(TimeSpan, CancellationToken)

Enters the lock in exclusive mode asynchronously.

Declaration
public ValueTask AcquireAsync(TimeSpan timeout, CancellationToken token = null)
Parameters
Type Name Description
TimeSpan timeout

The interval to wait for the lock.
CancellationToken token

The token that can be used to abort lock acquisition.
Returns
Type Description
ValueTask

The task representing lock acquisition operation.
| Improve this Doc View Source

Release()

Releases previously acquired exclusive lock.

Declaration
public void Release()
| Improve this Doc View Source

TryAcquire()

Attempts to obtain exclusive lock synchronously without blocking caller thread.

Declaration
public bool TryAcquire()
Returns
Type Description
Boolean

true if lock is taken successfuly; otherwise, false.
| Improve this Doc View Source

TryAcquireAsync(TimeSpan, CancellationToken)

Tries to enter the lock in exclusive mode asynchronously, with an optional time-out.

Declaration
public ValueTask<bool> TryAcquireAsync(TimeSpan timeout, CancellationToken token = null)
Parameters
Type Name Description
TimeSpan timeout

The interval to wait for the lock.
CancellationToken token

The token that can be used to abort lock acquisition.
Returns
Type Description
ValueTask<Boolean>

true if the caller entered exclusive mode; otherwise, false.

Implements

IAsyncDisposable

Extension Methods