IActorStateProvider Interface

Definition

Namespace:

Microsoft.ServiceFabric.Actors.Runtime

Assembly:

Microsoft.ServiceFabric.Actors.dll

Package:

Microsoft.ServiceFabric.Actors v6.1.1583

Represents the interface that an actor state provider needs to implement for actor runtime to communicate with it.

public interface IActorStateProvider : Microsoft.ServiceFabric.Data.IStateProviderReplica2

type IActorStateProvider = interface
    interface IStateProviderReplica2
    interface IStateProviderReplica

Public Interface IActorStateProvider
Implements IStateProviderReplica2

Derived

Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase

Microsoft.ServiceFabric.Actors.Runtime.ReliableCollectionsActorStateProvider

Microsoft.ServiceFabric.Actors.Runtime.VolatileActorStateProvider

Implements

IStateProviderReplica IStateProviderReplica2

Properties

OnDataLossAsync	Function called during suspected data-loss. (Inherited from IStateProviderReplica)
OnRestoreCompletedAsync	Function called after restore has been performed on the replica. (Inherited from IStateProviderReplica2)

Methods

Abort()	Forcefully abort the state provider replica. (Inherited from IStateProviderReplica)
ActorActivatedAsync(ActorId, CancellationToken)	Invoked as part of the activation process of the actor with the specified actor ID.
BackupAsync(BackupOption, TimeSpan, CancellationToken, Func<BackupInfo,CancellationToken,Task<Boolean>>)	Performs a backup of all reliable state managed by this IReliableStateManager. (Inherited from IStateProviderReplica)
BackupAsync(Func<BackupInfo,CancellationToken,Task<Boolean>>)	Performs a full backup of all reliable state managed by this IReliableStateManager. (Inherited from IStateProviderReplica)
ChangeRoleAsync(ReplicaRole, CancellationToken)	Notify the state provider replica that its role is changing, for example to Primary or Secondary. (Inherited from IStateProviderReplica)
CloseAsync(CancellationToken)	Gracefully close the state provider replica. (Inherited from IStateProviderReplica)
ContainsStateAsync(ActorId, String, CancellationToken)	Checks whether actor state provider contains an actor state with specified state name for the specified actor ID.
DeleteReminderAsync(ActorId, String, CancellationToken)	Deletes the actor reminder with the given reminder name if it exists
DeleteRemindersAsync(IReadOnlyDictionary<ActorId,IReadOnlyCollection<String>>, CancellationToken)	Deletes the specified set of reminders.
EnumerateStateNamesAsync(ActorId, CancellationToken)	Creates an enumerable of all the state names associated with specified actor ID.
GetActorsAsync(Int32, ContinuationToken, CancellationToken)	Gets the requested number of ActorID's from the state provider.
GetRemindersAsync(Int32, ActorId, ContinuationToken, CancellationToken)	Gets the list of reminders from the state provider
Initialize(ActorTypeInformation)	Initializes the actor state provider with type information of the actor type associated with it.
Initialize(StatefulServiceInitializationParameters)	Initialize the state provider replica using the service initialization information. (Inherited from IStateProviderReplica)
LoadRemindersAsync(CancellationToken)	Loads all the reminders contained in the actor state provider.
LoadStateAsync<T>(ActorId, String, CancellationToken)	Loads the actor state associated with the specified state name for the specified actor ID.
OpenAsync(ReplicaOpenMode, IStatefulServicePartition, CancellationToken)	Open the state provider replica for use. (Inherited from IStateProviderReplica)
ReminderCallbackCompletedAsync(ActorId, IActorReminder, CancellationToken)	Invoked when a reminder fires and finishes executing its callback ReceiveReminderAsync(String, Byte[], TimeSpan, TimeSpan) successfully.
RemoveActorAsync(ActorId, CancellationToken)	Removes all the existing states and reminders associated with specified actor ID atomically.
RestoreAsync(String)	Restore a backup taken by BackupAsync(Func<BackupInfo,CancellationToken,Task<Boolean>>) or BackupAsync(BackupOption, TimeSpan, CancellationToken, Func<BackupInfo,CancellationToken,Task<Boolean>>). (Inherited from IStateProviderReplica)
RestoreAsync(String, RestorePolicy, CancellationToken)	Restore a backup taken by BackupAsync(Func<BackupInfo,CancellationToken,Task<Boolean>>) or BackupAsync(BackupOption, TimeSpan, CancellationToken, Func<BackupInfo,CancellationToken,Task<Boolean>>). (Inherited from IStateProviderReplica)
SaveReminderAsync(ActorId, IActorReminder, CancellationToken)	Saves the specified actor ID reminder. If an actor reminder with given name does not exist, it adds the actor reminder otherwise existing actor reminder with same name is updated.
SaveStateAsync(ActorId, IReadOnlyCollection<ActorStateChange>, CancellationToken)	Saves the specified set of actor state changes for the specified actor ID atomically.