IActorStateManager.GetOrAddStateAsync<T> 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 the given state name if it exists. If it does not exist, creates and new state with the specified name and value.

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

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

Public Function GetOrAddStateAsync(Of T) (stateName As String, value As T, 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 or add.

value: T

Value of the actor state to add if it does not exist.

cancellationToken: CancellationToken

The token to monitor for cancellation requests.

Returns

Task<T>

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

Exceptions

ArgumentNullException

The specified state name is null. Provide a valid state name string.

OperationCanceledException

The request was canceled using the specified cancellationToken.

Remarks

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

Applies to