ActorStateProvider Schnittstelle

Paket:

microsoft.servicefabric.actors.runtime

public interface ActorStateProvider extends StateProviderReplica

Stellt die Schnittstelle dar, die ein Akteurzustandsanbieter implementieren muss, damit die Actor Runtime mit ihr kommunizieren kann.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
CompletableFuture<?>	actorActivatedAsync(ActorId actorId, CancellationToken cancellationToken) Diese Methode wird im Rahmen des Aktivierungsprozesses des Akteurs mit der angegebenen ID aufgerufen.
CompletableFuture<Boolean>	containsStateAsync(ActorId actorId, String stateName, CancellationToken cancellationToken) Überprüft, ob der Akteurstatusanbieter einen Akteurstatus mit dem angegebenen Statusnamen enthält.
CompletableFuture<?>	deleteReminderAsync(ActorId actorId, String reminderName, CancellationToken cancellationToken) Löscht die angegebene Actor-Erinnerung, sofern vorhanden.
CompletableFuture<?>	deleteRemindersAsync(Map<ActorId, Collection<String>> reminderNames, CancellationToken cancellationToken) Löscht den angegebenen Erinnerungssatz.
CompletableFuture<List<String>>	enumerateStateNamesAsync(ActorId actorId, CancellationToken cancellationToken) Erstellt eine Aufzählung aller Zustandsnamen, die dem angegebenen Akteur zugeordnet sind. Bemerkungen:Der vom Akteurstatusanbieter zurückgegebene Enumerator kann sicher gleichzeitig mit Lese- und Schreibvorgängen an den Zustandsanbieter verwendet werden. Sie stellt eine Momentaufnahme konsistente Ansicht des Zustandsanbieters dar.
CompletableFuture<PagedResult<ActorId>>	getActorsAsync(int numItemsToReturn, ContinuationToken continuationToken, CancellationToken cancellationToken) Ruft ActorIds vom Zustandsanbieter ab. Bemerkungen: Das
void	initialize(ActorTypeInformation actorTypeInformation) Initialisiert den Akteurzustandsanbieter mit Typinformationen des zugeordneten Akteurtyps.
CompletableFuture<ActorReminderCollection>	loadRemindersAsync(CancellationToken cancellationToken) Lädt alle Erinnerungen, die im Akteurzustandsanbieter enthalten sind.
<T> CompletableFuture<T>	loadStateAsync(ActorId actorId, String stateName, CancellationToken cancellationToken) Lädt den Akteurstatus, der dem angegebenen Statusnamen zugeordnet ist.
CompletableFuture<?>	reminderCallbackCompletedAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken) Wird aufgerufen, wenn eine Erinnerung ausgelöst wird und die Ausführung des Rückrufs receiveReminderAsync(String reminderName, byte[] context, Duration timeSpan, Duration period) erfolgreich abgeschlossen wird
CompletableFuture<?>	removeActorAsync(ActorId actorId, CancellationToken cancellationToken) Entfernt alle vorhandenen Zustände und Erinnerungen, die dem angegebenen Akteur atomar zugeordnet sind.
CompletableFuture<?>	saveReminderAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken) Speichert die angegebene Akteurerinnerung. Wenn eine Akteurerinnerung mit dem angegebenen Namen nicht vorhanden ist, wird die Akteurerinnerung hinzugefügt, andernfalls wird eine vorhandene Akteurerinnerung mit demselben Namen aktualisiert.
CompletableFuture<?>	saveStateAsync(ActorId actorId, List<ActorStateChange> stateChanges, CancellationToken cancellationToken) Speichert den angegebenen Satz von Akteurzustandsänderungen atomar. Bemerkungen: Die Auflistung der Zustandsänderungen sollte nur ein Element für einen bestimmten Zustandsnamen enthalten. Der Speichervorgang schlägt fehl, wenn versucht wird, einen bereits vorhandenen Akteurstatus hinzuzufügen oder einen nicht vorhandenen Akteurstatus zu aktualisieren bzw. zu entfernen.

Geerbte Elemente

StateProviderReplica.abort() StateProviderReplica.backupAsync(BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> backupCallback) StateProviderReplica.backupAsync(BackupOption option, Duration timeout, CancellationToken cancellationToken, BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> backupCallback) StateProviderReplica.changeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken) StateProviderReplica.closeAsync(CancellationToken cancellationToken) StateProviderReplica.initialize(StatefulServiceInitializationParameters initializationParameters) StateProviderReplica.openAsync(ReplicaOpenMode openMode, StatefulServicePartition partition, CancellationToken cancellationToken) StateProviderReplica.restoreAsync(String backupFolderPath) StateProviderReplica.restoreAsync(String backupFolderPath, RestorePolicy restorePolicy, Duration timeout, CancellationToken cancellationToken) StateProviderReplica.setOnDataLossCallback(Function<CancellationToken, CompletableFuture<Boolean>> onDataLossAsync)

Details zur Methode

actorActivatedAsync

public CompletableFuture actorActivatedAsync(ActorId actorId, CancellationToken cancellationToken)

Diese Methode wird im Rahmen des Aktivierungsprozesses des Akteurs mit der angegebenen ID aufgerufen.

Parameter:

actorId - ID des aktivierten Akteurs.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die die asynchrone Verarbeitung der Actor-Aktivierungsbenachrichtigung darstellt.

containsStateAsync

public CompletableFuture containsStateAsync(ActorId actorId, String stateName, CancellationToken cancellationToken)

Überprüft, ob der Akteurstatusanbieter einen Akteurstatus mit dem angegebenen Statusnamen enthält.

Parameter:

actorId - ID des Akteurs, für den die Statusexistenz überprüft werden soll.

stateName - Name des Akteurstatus, der auf Existenz überprüft werden soll.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Überprüfungsvorgang darstellt. Der Wert des TResult-Parameters ist true, wenn der Zustand mit dem angegebenen Namen andernfalls false vorhanden ist.

deleteReminderAsync

public CompletableFuture deleteReminderAsync(ActorId actorId, String reminderName, CancellationToken cancellationToken)

Löscht die angegebene Actor-Erinnerung, sofern vorhanden.

Parameter:

actorId - ID des Akteurs, für den die Erinnerung gelöscht werden soll.

reminderName - Name der zu löschenden Erinnerung.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Löschvorgang darstellt.

deleteRemindersAsync

public CompletableFuture deleteRemindersAsync(Map> reminderNames, CancellationToken cancellationToken)

Löscht den angegebenen Erinnerungssatz.

Parameter:

reminderNames - Der Satz der zu löschenden Erinnerungen

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Löschvorgang darstellt.

enumerateStateNamesAsync

public CompletableFuture> enumerateStateNamesAsync(ActorId actorId, CancellationToken cancellationToken)

Erstellt eine Aufzählung aller Zustandsnamen, die dem angegebenen Akteur zugeordnet sind.

Bemerkungen:Der vom Akteurstatusanbieter zurückgegebene Enumerator kann sicher gleichzeitig mit Lese- und Schreibvorgängen an den Zustandsanbieter verwendet werden. Sie stellt eine Momentaufnahme konsistente Ansicht des Zustandsanbieters dar.

Parameter:

actorId - ID des Akteurs, für den enumerable erstellt werden soll.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Enumerationsvorgang darstellt. Der Wert des TResult-Parameters ist eine Aufzählung aller Zustandsnamen, die dem angegebenen Actor zugeordnet sind.

getActorsAsync

public CompletableFuture> getActorsAsync(int numItemsToReturn, ContinuationToken continuationToken, CancellationToken cancellationToken)

Ruft ActorIds vom Zustandsanbieter ab.

Bemerkungen: Das

Parameter:

numItemsToReturn - Anzahl der Elemente, die zurückgegeben werden sollen.

continuationToken - Ein Fortsetzungstoken, aus dem mit der Abfrage der Ergebnisse begonnen werden soll. Ein NULL-Wert des Fortsetzungstokens bedeutet, dass werte vom Anfang zurückgegeben werden.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Vorgang des Aufrufs an den Server darstellt.

initialize

public void initialize(ActorTypeInformation actorTypeInformation)

Initialisiert den Akteurzustandsanbieter mit Typinformationen des zugeordneten Akteurtyps.

Parameter:

actorTypeInformation - Typinformationen der Actor-Klasse

loadRemindersAsync

public CompletableFuture loadRemindersAsync(CancellationToken cancellationToken)

Lädt alle Erinnerungen, die im Akteurzustandsanbieter enthalten sind.

Parameter:

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Ladevorgang darstellt. Der Wert des TResult-Parameters ist eine Sammlung aller Akteurerinnerungen, die im Actor-Zustandsanbieter enthalten sind.

loadStateAsync

public CompletableFuture loadStateAsync(ActorId actorId, String stateName, CancellationToken cancellationToken)

Lädt den Akteurstatus, der dem angegebenen Statusnamen zugeordnet ist.

Parameter:

actorId - ID des Akteurs, für den der Zustand geladen werden soll.

stateName - Name des zu ladenden Akteurstatus.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Ladevorgang darstellt. Der Wert des TResult-Parameters enthält den Wert des Akteurzustands, der dem angegebenen Statusnamen zugeordnet ist.

reminderCallbackCompletedAsync

public CompletableFuture reminderCallbackCompletedAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken)

Wird aufgerufen, wenn eine Erinnerung ausgelöst wird und die Ausführung des Rückrufs receiveReminderAsync(String reminderName, byte[] context, Duration timeSpan, Duration period) erfolgreich abgeschlossen wird

Parameter:

actorId - ID des Akteurs, der die Erinnerung besitzt

reminder - Akteurerinnerung, die erfolgreich abgeschlossen wurde.

cancellationToken - Das Token zum Überwachen von Abbruchanforderungen.

Gibt zurück:

Eine Aufgabe, die den asynchronen Erinnerungsrückruf darstellt, der die Verarbeitung von Benachrichtigungen abgeschlossen hat.

removeActorAsync

public CompletableFuture removeActorAsync(ActorId actorId, CancellationToken cancellationToken)

Entfernt alle vorhandenen Zustände und Erinnerungen, die dem angegebenen Akteur atomar zugeordnet sind.

Parameter:

actorId - ID des Akteurs, für den der Status entfernt werden soll.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Entfernungsvorgang darstellt.

saveReminderAsync

public CompletableFuture saveReminderAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken)

Speichert die angegebene Akteurerinnerung. Wenn eine Akteurerinnerung mit dem angegebenen Namen nicht vorhanden ist, wird die Akteurerinnerung hinzugefügt, andernfalls wird eine vorhandene Akteurerinnerung mit demselben Namen aktualisiert.

Parameter:

actorId - ID des Akteurs, für den die Erinnerung gespeichert werden soll.

reminder - Zu speichernde Akteurerinnerung.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Speichervorgang darstellt.

saveStateAsync

public CompletableFuture saveStateAsync(ActorId actorId, List stateChanges, CancellationToken cancellationToken)

Speichert den angegebenen Satz von Akteurzustandsänderungen atomar.

Bemerkungen: Die Auflistung der Zustandsänderungen sollte nur ein Element für einen bestimmten Zustandsnamen enthalten. Der Speichervorgang schlägt fehl, wenn versucht wird, einen bereits vorhandenen Akteurstatus hinzuzufügen oder einen nicht vorhandenen Akteurstatus zu aktualisieren bzw. zu entfernen.

Parameter:

actorId - ID des Akteurs, für den die Zustandsänderungen gespeichert werden sollen.

stateChanges - Sammlung der zu speichernden Zustandsänderungen.

cancellationToken -

CancellationToken-Objekt, um den Abbruch status des Vorgangs anzugeben.

Gibt zurück:

Eine Aufgabe, die den asynchronen Speichervorgang darstellt.