Struct AsyncKeyedReaderWriterLockUpgradeableReadToken<TKey>

Namespace

LfrlAnvil.Async

Assembly

LfrlAnvil.Core.dll

Represents an acquired upgradeable read lock from an AsyncKeyedReaderWriterLock<TKey> instance.

public readonly struct AsyncKeyedReaderWriterLockUpgradeableReadToken<TKey> : IDisposable where TKey : notnull

Type Parameters

TKey

Key's type.

Implements

IDisposable

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

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

ObjectExtensions.ToNullable<T>(T)

ObjectExtensions.ToRef<T>(T)

ObjectExtensions.TryDispose<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>, Func<T, bool>)

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

Properties

Key

Associated key.

public TKey? Key { get; }

Property Value

TKey

Lock

Associated AsyncKeyedReaderWriterLock<TKey> instance.

public AsyncKeyedReaderWriterLock<TKey>? Lock { get; }

Property Value

AsyncKeyedReaderWriterLock<TKey>

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Exceptions

InvalidOperationException

When this upgradeable read lock is in the process of being upgraded to a write lock, or has already been upgraded.

TryUpgrade(out bool)

Attempts to synchronously upgrade this lock to a write lock.

public AsyncKeyedReaderWriterLockUpgradedReadToken<TKey> TryUpgrade(out bool entered)

Parameters

entered bool

out parameter which specifies whether the upgrade was completed.

Returns

AsyncKeyedReaderWriterLockUpgradedReadToken<TKey>

New AsyncKeyedReaderWriterLockUpgradedReadToken<TKey> value. When entered is false, then returned instanced will be a default value.

Exceptions

InvalidOperationException

When this upgradeable read lock has been released, or it's already in the process of being upgraded, or has already been upgraded.

UpgradeAsync(CancellationToken)

Asynchronously upgrades this upgradeable read lock to a write lock.

public ValueTask<AsyncKeyedReaderWriterLockUpgradedReadToken<TKey>> UpgradeAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Optional CancellationToken that can be used to cancel pending upgrade.

Returns

ValueTask<AsyncKeyedReaderWriterLockUpgradedReadToken<TKey>>

New ValueTask<TResult> instance which returns an AsyncKeyedReaderWriterLockUpgradedReadToken<TKey> value.

Exceptions

OperationCanceledException

When provided cancellationToken was cancelled before the upgrade was completed.

InvalidOperationException

When this upgradeable read lock has been released, or it's already in the process of being upgraded, or has already been upgraded.