KvsActorStateProviderBase.IActorStateProvider.GetActorsAsync 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 the ActorIds from the State Provider.

System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>> IActorStateProvider.GetActorsAsync (int numItemsToReturn, Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, System.Threading.CancellationToken cancellationToken);

abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync : int * Microsoft.ServiceFabric.Actors.Query.ContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>>
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync : int * Microsoft.ServiceFabric.Actors.Query.ContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>>

Function GetActorsAsync (numItemsToReturn As Integer, continuationToken As ContinuationToken, cancellationToken As CancellationToken) As Task(Of PagedResult(Of ActorId)) Implements IActorStateProvider.GetActorsAsync

Parameters

numItemsToReturn: Int32

The number of items requested to be returned.

continuationToken: ContinuationToken

A continuation token to start querying the results from. A null value of continuation token means start returning values form the beginning.

cancellationToken: CancellationToken

The token to monitor for cancellation requests.

Returns

Task<PagedResult<ActorId>>

A task that represents the asynchronous operation of call to server.

Implements

GetActorsAsync(Int32, ContinuationToken, CancellationToken)

Exceptions

OperationCanceledException

The operation was canceled.

Remarks

The continuationToken is relative to the state of actor state provider at the time of invocation of this API. If the state of actor state provider changes (i.e. new actors are activated or existing actors are deleted) in between calls to this API and the continuation token from previous call (before the state was modified) is supplied, the result may contain entries that were already fetched in previous calls.

Applies to