IActorStateManager.TryGetStateAsync<T> Method

Definition

Namespace:

Microsoft.ServiceFabric.Actors.Runtime

Assembly:

Microsoft.ServiceFabric.Actors.dll

Package:

Microsoft.ServiceFabric.Actors v6.1.1583

Attempts to get an actor state with specified state name.

public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<T>> TryGetStateAsync<T> (string stateName, System.Threading.CancellationToken cancellationToken = default);

abstract member TryGetStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<'T>>

Public Function TryGetStateAsync(Of T) (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ConditionalValue(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<ConditionalValue<T>>

A task that represents the asynchronous get operation. The value of TResult parameter contains ConditionalValue<TValue> indicating whether the actor state is present and the value of actor state if it is present.

Exceptions

ArgumentNullException

The specified state name is null.

OperationCanceledException

The operation was canceled.

Remarks

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