Struct UpgradeableReadLockSlim

Namespace

LfrlAnvil.Async

Assembly

LfrlAnvil.Core.dll

A lightweight, disposable object representing an acquired upgradeable read lock.

public readonly struct UpgradeableReadLockSlim : IDisposable

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.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>)

Methods

Dispose()

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

public void Dispose()

Remarks

Releases previously acquired upgradeable read lock.

Exceptions

SynchronizationLockException

Attempt to release an upgradeable read lock has thrown an exception of this type. See ExitUpgradeableReadLock() for more information.

Enter(ReaderWriterLockSlim)

Acquires an upgradeable read lock on the provided ReaderWriterLockSlim instance.

public static UpgradeableReadLockSlim Enter(ReaderWriterLockSlim @lock)

Parameters

lock ReaderWriterLockSlim

A reader/writer lock object on which to acquire the upgradeable read lock.

Returns

UpgradeableReadLockSlim

A disposable UpgradeableReadLockSlim instance.

Exceptions

ObjectDisposedException

The lock has been disposed.

LockRecursionException

Attempt to acquire an upgradeable read lock has thrown an exception of this type. See EnterUpgradeableReadLock() for more information.

TryEnter(ReaderWriterLockSlim, out bool)

Attempts to acquire an upgradeable read lock on the provided ReaderWriterLockSlim instance. If the lock has been disposed, then the upgradeable read lock will not be acquired.

public static UpgradeableReadLockSlim TryEnter(ReaderWriterLockSlim @lock, out bool entered)

Parameters

lock ReaderWriterLockSlim

A reader/writer lock object on which to acquire the upgradeable read lock.

entered bool

An out parameter set to true when upgradeable read lock has been acquired, otherwise false.

Returns

UpgradeableReadLockSlim

A disposable UpgradeableReadLockSlim instance. Upgradeable read lock will not be acquired if lock has been disposed.

Exceptions

LockRecursionException

Attempt to acquire an upgradeable read lock has thrown an exception of this type. See EnterUpgradeableReadLock() for more information.

Upgrade()

Attempts to upgrade acquired read lock to write lock.

public WriteLockSlim Upgrade()

Returns

WriteLockSlim

A disposable WriteLockSlim instance. Write lock will not be acquired if this upgradeable read lock has not been acquired beforehand.

Remarks

This method assumes that the current thread holds an upgradeable read lock. See Assume for more information.

Exceptions

ObjectDisposedException

The underlying ReaderWriterLockSlim instance has been disposed.

LockRecursionException

Attempt to acquire a write lock has thrown an exception of this type. See EnterWriteLock() for more information.