IActorStateManager.GetStateAsync<T>(String, CancellationToken) Method

Reference

Definition

Namespace:: Microsoft.ServiceFabric.Actors.Runtime

Assembly:: Microsoft.ServiceFabric.Actors.dll

Package:: Microsoft.ServiceFabric.Actors v6.1.1583

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets an actor state with specified state name.

public System.Threading.Tasks.Task<T> GetStateAsync<T> (string stateName, System.Threading.CancellationToken cancellationToken = default);

abstract member GetStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>

Public Function GetStateAsync(Of T) (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of T)

Type Parameters

T

Type of value associated with given state name.

Parameters

stateName: String

Name of the actor state to get.

cancellationToken: CancellationToken

The token to monitor for cancellation requests.

Returns

Task<T>

A task that represents the asynchronous get operation. The value of TResult parameter contains value of actor state with given state name.

Exceptions

KeyNotFoundException

An actor state with given state name does not exist.

ArgumentNullException

The specified state name is null.

OperationCanceledException

The operation was canceled.

Remarks

The type of state value T must be Data Contract serializable.

Applies to