Class AsyncKeyReaderWriterLock<TKey>

Extension of the AsyncReaderWriterLock that enables fine-grained locking on a given key. Concurrent write lock requests using different keys can execute simultaneously, while requests to lock using the same key will be forced to wait. This object is thread-safe and internally uses a pooling mechanism to minimize allocation of new locks.

Inheritance

object

AsyncKeyReaderWriterLock<TKey>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: SixLabors.ImageSharp.Web.Synchronization

Assembly: SixLabors.ImageSharp.Web.dll

Syntax

public class AsyncKeyReaderWriterLock<TKey> where TKey : notnull

Type Parameters

Name	Description
TKey	The type of the key.

Constructors

AsyncKeyReaderWriterLock(int)

Initializes a new instance of the AsyncKeyReaderWriterLock<TKey> class.

Declaration

public AsyncKeyReaderWriterLock(int maxPoolSize = 64)

Parameters

Type	Name	Description
int	maxPoolSize	The maximum number of locks that should be pooled for reuse.

Methods

ReaderLockAsync(TKey)

Locks the current thread in read mode asynchronously.

Declaration

public Task<IDisposable> ReaderLockAsync(TKey key)

Parameters

Type	Name	Description
TKey	key	The key identifying the specific object to lock against.

Returns

Type	Description
Task<IDisposable>	The IDisposable that will release the lock.

WriterLockAsync(TKey)

Locks the current thread in write mode asynchronously.

Declaration

public Task<IDisposable> WriterLockAsync(TKey key)

Parameters

Type	Name	Description
TKey	key	The key identifying the specific object to lock against.

Returns

Type	Description
Task<IDisposable>	The IDisposable that will release the lock.