ActorStateProvider インターフェイス

パッケージ:

microsoft.servicefabric.actors.runtime

public interface ActorStateProvider extends StateProviderReplica

アクター状態プロバイダーがアクター ランタイムと通信するために実装する必要があるインターフェイスを表します。

メソッドの概要

修飾子と型	メソッドと説明
CompletableFuture<?>	actorActivatedAsync(ActorId actorId, CancellationToken cancellationToken) このメソッドは、指定された ID を持つアクターのアクティブ化プロセスの一部として呼び出されます。
CompletableFuture<Boolean>	containsStateAsync(ActorId actorId, String stateName, CancellationToken cancellationToken) アクター状態プロバイダーに、指定された状態名を持つアクター状態が含まれているかどうかを確認します。
CompletableFuture<?>	deleteReminderAsync(ActorId actorId, String reminderName, CancellationToken cancellationToken) 指定したアクター アラームが存在する場合は削除します。
CompletableFuture<?>	deleteRemindersAsync(Map<ActorId, Collection<String>> reminderNames, CancellationToken cancellationToken) 指定したアラームのセットを削除します
CompletableFuture<List<String>>	enumerateStateNamesAsync(ActorId actorId, CancellationToken cancellationToken) 指定したアクターに関連付けられているすべての状態名の列挙可能な を作成します。 発言：アクター状態プロバイダーから返される列挙子は、状態プロバイダーへの読み取りと書き込みと同時に使用しても安全です。 これは、状態プロバイダーのスナップショット一貫性のあるビューを表します。
CompletableFuture<PagedResult<ActorId>>	getActorsAsync(int numItemsToReturn, ContinuationToken continuationToken, CancellationToken cancellationToken) 状態プロバイダーから ActorIds を取得します。 発言： 次の値を使用
void	initialize(ActorTypeInformation actorTypeInformation) アクターの状態プロバイダーを、それに関連付けられているアクター型の型情報で初期化します。
CompletableFuture<ActorReminderCollection>	loadRemindersAsync(CancellationToken cancellationToken) アクター状態プロバイダーに含まれるすべてのアラームを読み込みます。
<T> CompletableFuture<T>	loadStateAsync(ActorId actorId, String stateName, CancellationToken cancellationToken) 指定した状態名に関連付けられているアクター状態を読み込みます。
CompletableFuture<?>	reminderCallbackCompletedAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken) アラームが起動し、コールバック receiveReminderAsync(String reminderName, byte[] context, Duration timeSpan, Duration period) の実行が正常に完了したときに呼び出されます
CompletableFuture<?>	removeActorAsync(ActorId actorId, CancellationToken cancellationToken) 指定したアクターに関連付けられている既存のすべての状態とアラームをアトミックに削除します。
CompletableFuture<?>	saveReminderAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken) 指定したアクター アラームを保存します。 指定された名前のアクター アラームが存在しない場合は、アクター アラームが追加されます。それ以外の場合は、同じ名前の既存のアクター アラームが更新されます。
CompletableFuture<?>	saveStateAsync(ActorId actorId, List<ActorStateChange> stateChanges, CancellationToken cancellationToken) 指定したアクター状態の変更のセットをアトミックに保存します。 発言： 状態変更のコレクションには、特定の状態名に対して 1 つの項目のみを含める必要があります。 保存操作は、既に存在するアクター状態を追加したり、存在しないアクター状態を更新または削除したりしようとすると失敗します。

継承メンバー

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)

メソッドの詳細

actorActivatedAsync

public CompletableFuture actorActivatedAsync(ActorId actorId, CancellationToken cancellationToken)

このメソッドは、指定された ID を持つアクターのアクティブ化プロセスの一部として呼び出されます。

パラメーター:

actorId - アクティブ化されたアクターの ID。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期アクターアクティブ化通知処理を表すタスク。

containsStateAsync

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

アクター状態プロバイダーに、指定された状態名を持つアクター状態が含まれているかどうかを確認します。

パラメーター:

actorId - 状態の存在をチェックするアクターの ID。

stateName - 存在するためにチェックするアクター状態の名前。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期チェック操作を表すタスク。 指定した名前の状態が存在する場合、TResult パラメーターの値は true、それ以外の場合は false です。

deleteReminderAsync

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

指定したアクター アラームが存在する場合は削除します。

パラメーター:

actorId - アラームを削除するアクターの ID。

reminderName - 削除するアラームの名前。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期削除操作を表すタスク。

deleteRemindersAsync

public CompletableFuture deleteRemindersAsync(Map> reminderNames, CancellationToken cancellationToken)

指定したアラームのセットを削除します

パラメーター:

reminderNames - 削除するアラームのセット

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期削除操作を表すタスク。

enumerateStateNamesAsync

public CompletableFuture> enumerateStateNamesAsync(ActorId actorId, CancellationToken cancellationToken)

指定したアクターに関連付けられているすべての状態名の列挙可能な を作成します。

発言：アクター状態プロバイダーから返される列挙子は、状態プロバイダーへの読み取りと書き込みと同時に使用しても安全です。 これは、状態プロバイダーのスナップショット一貫性のあるビューを表します。

パラメーター:

actorId - 列挙可能なを作成するアクターの ID。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期列挙操作を表すタスク。 TResult パラメーターの値は、指定されたアクターに関連付けられているすべての状態名の列挙可能です。

getActorsAsync

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

状態プロバイダーから ActorIds を取得します。

発言： 次の値を使用

パラメーター:

numItemsToReturn - 返す必要があるアイテムの数。

continuationToken - 結果のクエリを開始する継続トークン。 継続トークンの null 値は、先頭から値を返す開始を意味します。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

サーバーへの呼び出しの非同期操作を表すタスク。

initialize

public void initialize(ActorTypeInformation actorTypeInformation)

アクターの状態プロバイダーを、それに関連付けられているアクター型の型情報で初期化します。

パラメーター:

actorTypeInformation - アクター クラスの型情報

loadRemindersAsync

public CompletableFuture loadRemindersAsync(CancellationToken cancellationToken)

アクター状態プロバイダーに含まれるすべてのアラームを読み込みます。

パラメーター:

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期読み込み操作を表すタスク。 TResult パラメーターの値は、アクター状態プロバイダーに含まれるすべてのアクター アラームのコレクションです。

loadStateAsync

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

指定した状態名に関連付けられているアクター状態を読み込みます。

パラメーター:

actorId - 状態を読み込むアクターの ID。

stateName - 読み込むアクター状態の名前。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期読み込み操作を表すタスク。 TResult パラメーターの値には、指定された状態名に関連付けられているアクター状態の値が含まれています。

reminderCallbackCompletedAsync

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

アラームが起動し、コールバック receiveReminderAsync(String reminderName, byte[] context, Duration timeSpan, Duration period) の実行が正常に完了したときに呼び出されます

パラメーター:

actorId - アラームを所有するアクターの ID

reminder - アクターが正常に完了したことを通知します。

cancellationToken - キャンセル要求を監視するためのトークン。

戻り値:

非同期アラーム コールバック完了通知処理を表すタスク。

removeActorAsync

public CompletableFuture removeActorAsync(ActorId actorId, CancellationToken cancellationToken)

指定したアクターに関連付けられている既存のすべての状態とアラームをアトミックに削除します。

パラメーター:

actorId - 状態を削除するアクターの ID。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期の削除操作を表すタスク。

saveReminderAsync

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

指定したアクター アラームを保存します。 指定された名前のアクター アラームが存在しない場合は、アクター アラームが追加されます。それ以外の場合は、同じ名前の既存のアクター アラームが更新されます。

パラメーター:

actorId - アラームを保存するアクターの ID。

reminder - 保存するアクターアラーム。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期の保存操作を表すタスク。

saveStateAsync

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

指定したアクター状態の変更のセットをアトミックに保存します。

発言： 状態変更のコレクションには、特定の状態名に対して 1 つの項目のみを含める必要があります。 保存操作は、既に存在するアクター状態を追加したり、存在しないアクター状態を更新または削除したりしようとすると失敗します。

パラメーター:

actorId - 状態の変更を保存するアクターの ID。

stateChanges - 保存する状態変更のコレクション。

cancellationToken -

CancellationToken オブジェクトを使用して、操作のキャンセル状態を示します。

戻り値:

非同期の保存操作を表すタスク。