Class AsyncMutex

Namespace

LfrlAnvil.Async

Assembly

LfrlAnvil.Core.dll

Represents a source of a fair asynchronous mutex primitive.

public sealed class AsyncMutex

Inheritance

object

AsyncMutex

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.Memoize<T1, T2>(T1, Func<T1, IEnumerable<T2>>)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitManyWithSelf<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>)

ObjectExtensions.VisitMany<T>(T, Func<T, IEnumerable<T>>, Func<T, bool>)

ObjectExtensions.VisitWithSelf<T>(T?, Func<T, T?>)

ObjectExtensions.VisitWithSelf<T>(T, Func<T, T>, Func<T, bool>)

ObjectExtensions.Visit<T>(T?, Func<T, T?>)

ObjectExtensions.Visit<T>(T, Func<T, T>, Func<T, bool>)

Remarks

Lock is not reentrant.

Constructors

AsyncMutex()

Creates a new AsyncMutex instance.

public AsyncMutex()

Properties

Participants

Returns the total number of lock participants, which includes current lock holder and all waiters.

public int Participants { get; }

Property Value

int

Methods

EnterAsync(CancellationToken)

Asynchronously acquires an exclusive lock from this mutex.

public ValueTask<AsyncMutexLock> EnterAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional CancellationToken that can be used to cancel pending mutex acquisition.

Returns

ValueTask<AsyncMutexLock>

New ValueTask<TResult> instance which returns an AsyncMutexLock value.

Exceptions

OperationCanceledException

When provided cancellationToken was cancelled before the lock was acquired.

TrimExcess()

Attempts to discard unused resources.

public void TrimExcess()