RedisCache.GetAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Extensions.Caching.StackExchangeRedis

Assembly:

Microsoft.Extensions.Caching.StackExchangeRedis.dll

Gets a value with the given key.

public System.Threading.Tasks.Task<byte[]> GetAsync (string key, System.Threading.CancellationToken token = default);

abstract member GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<byte[]>
override this.GetAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<byte[]>

Public Function GetAsync (key As String, Optional token As CancellationToken = Nothing) As Task(Of Byte())

Parameters

key

String

A string identifying the requested value.

token

CancellationToken

Optional. The CancellationToken used to propagate notifications that the operation should be canceled.

Returns

Task<Byte[]>

The Task that represents the asynchronous operation, containing the located value or null.

Implements

GetAsync(String, CancellationToken)

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Get(String).