Class RandomAccessCache<TKey, TValue>

Represents concurrent cache optimized for random access.

Inheritance

object

Disposable

RandomAccessCache<TKey, TValue>

Implements

IDisposable

IAsyncDisposable

Inherited Members

Disposable.IsDisposed

Disposable.IsDisposing

Disposable.IsDisposingOrDisposed

Disposable.DisposedTask

Disposable.GetDisposedTask<T>()

Disposable.TrySetDisposedException<T>(TaskCompletionSource<T>)

Disposable.TrySetDisposedException(TaskCompletionSource)

Disposable.TryBeginDispose()

Disposable.Dispose()

Disposable.Dispose(IEnumerable<IDisposable>)

Disposable.DisposeAsync(IEnumerable<IAsyncDisposable>)

Disposable.Dispose(ReadOnlySpan<IDisposable>)

Disposable.DisposeAsync(params IAsyncDisposable[])

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DotNext.Runtime.Caching

Assembly: DotNext.Threading.dll

Syntax

public class RandomAccessCache<TKey, TValue> : Disposable, IDisposable, IAsyncDisposable where TKey : notnull where TValue : notnull

Type Parameters

Name	Description
TKey	The type of the keys.
TValue	The type of the values.

Remarks

The cache evicts older records on overflow.

Constructors

| Edit this page View Source

RandomAccessCache(int)

Initializes a new cache.

Declaration

public RandomAccessCache(int cacheSize)

Parameters

Type	Name	Description
int	cacheSize	Maximum cache size.

Exceptions

Type	Condition
ArgumentOutOfRangeException	`cacheSize` is less than or equal to zero.

Properties

| Edit this page View Source

Eviction

Gets or sets a callback that can be used to clean up the evicted value.

Declaration

public Action<TKey, TValue>? Eviction { get; init; }

Property Value

Type	Description
Action<TKey, TValue>

| Edit this page View Source

KeyComparer

Gets or sets key comparer.

Declaration

public IEqualityComparer<TKey>? KeyComparer { get; init; }

Property Value

Type	Description
IEqualityComparer<TKey>

Methods

| Edit this page View Source

Change(TKey, TimeSpan)

Opens a session synchronously that can be used to modify the value associated with the key.

Declaration

public RandomAccessCache<TKey, TValue>.ReadOrWriteSession Change(TKey key, TimeSpan timeout)

Parameters

Type	Name	Description
TKey	key	The key of the cache record.
TimeSpan	timeout	The time to wait for the cache lock.

Returns

Type	Description
RandomAccessCache<TKey, TValue>.ReadOrWriteSession	The session that can be used to read or modify the cache record.

Remarks

The cache guarantees that the value cannot be evicted concurrently with the returned session. However, the value can be evicted immediately after. The caller must dispose session.

Exceptions

Type	Condition
TimeoutException	The internal lock cannot be acquired in timely manner.
ObjectDisposedException	The cache is disposed.

| Edit this page View Source

ChangeAsync(TKey, CancellationToken)

Opens a session that can be used to modify the value associated with the key.

Declaration

public ValueTask<RandomAccessCache<TKey, TValue>.ReadOrWriteSession> ChangeAsync(TKey key, CancellationToken token = default)

Parameters

Type	Name	Description
TKey	key	The key of the cache record.
CancellationToken	token	The token that can be used to cancel the operation.

Returns

Type	Description
ValueTask<RandomAccessCache<TKey, TValue>.ReadOrWriteSession>	The session that can be used to read or modify the cache record.

Remarks

The cache guarantees that the value cannot be evicted concurrently with the returned session. However, the value can be evicted immediately after. The caller must dispose session.

Exceptions

Type	Condition
OperationCanceledException	The operation has been canceled.
ObjectDisposedException	The cache is disposed.

| Edit this page View Source

Dispose(bool)

Releases managed and unmanaged resources associated with this object.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true if called from Dispose(); false if called from finalizer ~Disposable().

Overrides

Disposable.Dispose(bool)

| Edit this page View Source

DisposeAsync()

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

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask	A task that represents the asynchronous dispose operation.

| Edit this page View Source

DisposeAsyncCore()

Releases managed resources associated with this object asynchronously.

Declaration

protected override ValueTask DisposeAsyncCore()

Returns

Type	Description
ValueTask	The task representing asynchronous execution of this method.

Overrides

Disposable.DisposeAsyncCore()

Remarks

This method makes sense only if derived class implements IAsyncDisposable interface.

| Edit this page View Source

Invalidate(TKey, TimeSpan)

Declaration

public bool Invalidate(TKey key, TimeSpan timeout)

Parameters

Type	Name	Description
TKey	key
TimeSpan	timeout

Returns

Type	Description
bool

| Edit this page View Source

InvalidateAsync(CancellationToken)

Invalidates the entire cache.

Declaration

public ValueTask InvalidateAsync(CancellationToken token = default)

Parameters

Type	Name	Description
CancellationToken	token	The token that can be used to cancel the operation.

Returns

Type	Description
ValueTask

Exceptions

Type	Condition
OperationCanceledException	The operation has been canceled.
ObjectDisposedException	The cache is disposed.

| Edit this page View Source

InvalidateAsync(TKey, CancellationToken)

Invalidates the cache record associated with the specified key.

Declaration

public ValueTask<bool> InvalidateAsync(TKey key, CancellationToken token = default)

Parameters

Type	Name	Description
TKey	key	The key of the cache record to be removed.
CancellationToken	token	The token that can be used to cancel the operation.

Returns

Type	Description
ValueTask<bool>	true if the cache record associated with `key` is removed successfully; otherwise, false.

Exceptions

Type	Condition
OperationCanceledException	The operation has been canceled.
ObjectDisposedException	The cache is disposed.

| Edit this page View Source

TryRead(TKey, out ReadSession)

Tries to read the cached record.

Declaration

public bool TryRead(TKey key, out RandomAccessCache<TKey, TValue>.ReadSession session)

Parameters

Type	Name	Description
TKey	key	The key of the cache record.
RandomAccessCache<TKey, TValue>.ReadSession	session	A session that can be used to read the cached record.

Returns

Type	Description
bool	true if the record is available for reading and the session is active; otherwise, false.

Remarks

The cache guarantees that the value cannot be evicted concurrently with the session. However, the value can be evicted immediately after. The caller must dispose session.

| Edit this page View Source

TryRemove(TKey, TimeSpan, out ReadSession)

Tries to invalidate cache record associated with the provided key synchronously.

Declaration

public bool TryRemove(TKey key, TimeSpan timeout, out RandomAccessCache<TKey, TValue>.ReadSession session)

Parameters

Type	Name	Description
TKey	key	The key of the cache record to be removed.
TimeSpan	timeout
RandomAccessCache<TKey, TValue>.ReadSession	session	The session that can be used to read the removed cache record.

Returns

Type	Description
bool	true if the record associated with `key` exists; otherwise, false.

Exceptions

Type	Condition
TimeoutException	The internal lock cannot be acquired in timely manner.
ObjectDisposedException	The cache is disposed.

| Edit this page View Source

TryRemoveAsync(TKey, CancellationToken)

Tries to invalidate cache record associated with the provided key.

Declaration

public ValueTask<RandomAccessCache<TKey, TValue>.ReadSession?> TryRemoveAsync(TKey key, CancellationToken token = default)

Parameters

Type	Name	Description
TKey	key	The key of the cache record to be removed.
CancellationToken	token	The token that can be used to cancel the operation.

Returns

Type	Description
ValueTask<RandomAccessCache<TKey, TValue>.ReadSession?>	The session that can be used to read the removed cache record; or null if there is no record associated with `key`.