ReliableCollectionsActorStateProvider クラス

パッケージ:

microsoft.servicefabric.actors.runtime

• java.lang.Object
• • StateProviderReplica
  • • ActorStateProvider
    • • microsoft.servicefabric.actors.runtime.ReliableCollectionsActorStateProvider

public class ReliableCollectionsActorStateProvider implements ActorStateProvider

コンストラクターの概要

コンストラクター	説明
ReliableCollectionsActorStateProvider()
ReliableCollectionsActorStateProvider(ReliableStateManagerConfiguration stateManagerConfig)
ReliableCollectionsActorStateProvider(ReliableStateManagerConfiguration stateManagerConfig, int actorStateMapCount, int reminderMapCount)

メソッドの概要

修飾子と型	メソッドと説明
void	abort() 状態プロバイダー レプリカを強制的に中止します。 発言：これは通常、ノードで永続的な障害が検出された場合、または Service Fabric が内部障害のためにレプリカのライフサイクルを確実に管理できない場合に発生します。
CompletableFuture<?>	actorActivatedAsync(ActorId actorId, CancellationToken cancellationToken) このメソッドは、指定された ID を持つアクターのアクティブ化プロセスの一部として呼び出されます。
CompletableFuture<?>	backupAsync(BackupOption option, Duration timeout, CancellationToken cancellationToken, BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> backupCallback) この ReliableStateManager によって管理されるすべての信頼できる状態の完全バックアップを実行します。 発言： FULL バックアップは 1 時間のタイムアウトで実行されます。 backupCallback によって返されるブール値は、サービスがバックアップ フォルダーを外部の場所に正常に移動できたかどうかを示します。 false が返された場合、BackupAsync は、backupCallback が false を返したことを示す関連するメッセージと共に UnsupportedOperationException をスローします。 また、バックアップは失敗とマークされます。
CompletableFuture<?>	backupAsync(BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> backupCallback) この ReliableStateManager によって管理されるすべての信頼できる状態の完全バックアップを実行します。 発言： FULL バックアップは 1 時間のタイムアウトで実行されます。 backupCallback によって返されるブール値は、サービスがバックアップ フォルダーを外部の場所に正常に移動できたかどうかを示します。 false が返された場合、BackupAsync は、backupCallback が false を返したことを示す関連するメッセージと共に UnsupportedOperationException をスローします。 また、バックアップは失敗とマークされます。
CompletableFuture<?>	changeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken) 状態プロバイダー レプリカに、そのロールが変更されていることを通知します (たとえば、プライマリまたはセカンダリ)。
CompletableFuture<?>	closeAsync(CancellationToken cancellationToken) 状態プロバイダーレプリカを正常に閉じます。 発言：これは一般に、レプリカのコードがアップグレード中、負荷分散のためにレプリカが移動中、または一時的な障害が検出された場合に発生します。
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) アクター状態プロバイダーに関連付けられているアクター型の型情報を使用して初期化します。
void	initialize(StatefulServiceInitializationParameters initializationParameters) サービスの初期化情報を使用して、状態プロバイダー レプリカを初期化します。 発言：初期化中に複雑な処理を行う必要はありません。 OpenAsync では、コストのかかる初期化または実行時間の長い初期化を行う必要があります。
CompletableFuture<ActorReminderCollection>	loadRemindersAsync(CancellationToken cancellationToken) アクター状態プロバイダーに含まれるすべてのアラームを読み込みます。
<T> CompletableFuture<T>	loadStateAsync(ActorId actorId, String stateName, CancellationToken cancellationToken) 指定した状態名に関連付けられているアクター状態を読み込みます。
CompletableFuture<Replicator>	openAsync(ReplicaOpenMode openMode, StatefulServicePartition partition, 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<?>	restoreAsync(String backupFolderPath) 作成されたバックアップを復元します。 発言：安全な復元が実行されます。つまり、復元するデータが現在のレプリカの状態より前の場合にのみ復元が完了します。
CompletableFuture<?>	restoreAsync(String backupFolderPath, RestorePolicy restorePolicy, Duration timeout, CancellationToken cancellationToken) 作成されたバックアップを復元する
CompletableFuture<?>	saveReminderAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken) 指定したアクターアラームを保存します。 指定された名前のアクター アラームが存在しない場合は、アクター アラームが追加されます。それ以外の場合は、同じ名前の既存のアクター アラームが更新されます。
CompletableFuture<?>	saveStateAsync(ActorId actorId, List<ActorStateChange> stateChanges, CancellationToken cancellationToken) 指定したアクター状態の変更のセットをアトミックに保存します。 発言： 状態変更のコレクションには、特定の状態名に対して 1 つの項目のみを含める必要があります。 保存操作は、既に存在するアクター状態を追加しようとしたり、存在しないアクター状態を更新または削除したりしようとすると失敗します。
void	setOnDataLossCallback(Function<CancellationToken, CompletableFuture<Boolean>> onDataLossAsync) データ損失の疑いがある場合に呼び出される関数

継承メンバー

microsoft.servicefabric.actors.runtime.ActorStateProviderInternal.currentReplicaRole() microsoft.servicefabric.actors.runtime.ActorStateProviderInternal.traceId() microsoft.servicefabric.actors.runtime.ActorStateProviderInternal.traceType() microsoft.servicefabric.actors.runtime.ActorStateProviderInternal.transientErrorRetryDelay()

コンストラクターの詳細

ReliableCollectionsActorStateProvider

public ReliableCollectionsActorStateProvider()

ReliableCollectionsActorStateProvider

public ReliableCollectionsActorStateProvider(ReliableStateManagerConfiguration stateManagerConfig)

パラメーター:

stateManagerConfig

ReliableCollectionsActorStateProvider

public ReliableCollectionsActorStateProvider(ReliableStateManagerConfiguration stateManagerConfig, int actorStateMapCount, int reminderMapCount)

パラメーター:

stateManagerConfig

actorStateMapCount

reminderMapCount

メソッドの詳細

abort

public void abort()

状態プロバイダー レプリカを強制的に中止します。

発言：これは通常、ノードで永続的な障害が検出された場合、または Service Fabric が内部障害のためにレプリカのライフサイクルを確実に管理できない場合に発生します。

上書き:

ReliableCollectionsActorStateProvider.abort()

actorActivatedAsync

public CompletableFuture actorActivatedAsync(ActorId actorId, CancellationToken cancellationToken)

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

上書き:

ReliableCollectionsActorStateProvider.actorActivatedAsync(ActorId actorId, CancellationToken cancellationToken)

パラメーター:

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

backupAsync

public CompletableFuture backupAsync(BackupOption option, Duration timeout, CancellationToken cancellationToken, BiFunction> backupCallback)

この ReliableStateManager によって管理されるすべての信頼できる状態の完全バックアップを実行します。

発言： FULL バックアップは 1 時間のタイムアウトで実行されます。 backupCallback によって返されるブール値は、サービスがバックアップ フォルダーを外部の場所に正常に移動できたかどうかを示します。 false が返された場合、BackupAsync は、backupCallback が false を返したことを示す関連するメッセージと共に UnsupportedOperationException をスローします。 また、バックアップは失敗とマークされます。

上書き:

ReliableCollectionsActorStateProvider.backupAsync(BackupOption option, Duration timeout, CancellationToken cancellationToken, BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> backupCallback)

パラメーター:

option - 実行するバックアップの種類。

timeout - この操作のタイムアウト。

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

backupCallback - バックアップ フォルダーがローカルに作成され、ノードから移動する準備ができたときに呼び出されるコールバック

戻り値:

非同期バックアップ操作を表すタスク。

backupAsync

public CompletableFuture backupAsync(BiFunction> backupCallback)

この ReliableStateManager によって管理されるすべての信頼できる状態の完全バックアップを実行します。

発言： FULL バックアップは 1 時間のタイムアウトで実行されます。 backupCallback によって返されるブール値は、サービスがバックアップ フォルダーを外部の場所に正常に移動できたかどうかを示します。 false が返された場合、BackupAsync は、backupCallback が false を返したことを示す関連するメッセージと共に UnsupportedOperationException をスローします。 また、バックアップは失敗とマークされます。

上書き:

ReliableCollectionsActorStateProvider.backupAsync(BiFunction<BackupInfo, CancellationToken, CompletableFuture<Boolean>> backupCallback)

パラメーター:

backupCallback - バックアップ フォルダーがローカルに作成され、ノードから移動する準備ができたときに呼び出されるコールバック

戻り値:

非同期バックアップ操作を表すタスク。

changeRoleAsync

public CompletableFuture changeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken)

状態プロバイダー レプリカに、そのロールが変更されていることを通知します (たとえば、プライマリまたはセカンダリ)。

上書き:

ReliableCollectionsActorStateProvider.changeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken)

パラメーター:

newRole - プライマリやセカンダリなどの新しいレプリカ ロール。

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

非同期変更ロール操作を表すタスク。

closeAsync

public CompletableFuture closeAsync(CancellationToken cancellationToken)

状態プロバイダーレプリカを正常に閉じます。

発言：これは一般に、レプリカのコードがアップグレード中、負荷分散のためにレプリカが移動中、または一時的な障害が検出された場合に発生します。

上書き:

ReliableCollectionsActorStateProvider.closeAsync(CancellationToken cancellationToken)

パラメーター:

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

非同期の閉じる操作を表すタスク。

containsStateAsync

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

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

上書き:

ReliableCollectionsActorStateProvider.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)

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

上書き:

ReliableCollectionsActorStateProvider.deleteReminderAsync(ActorId actorId, String reminderName, CancellationToken cancellationToken)

パラメーター:

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

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

deleteRemindersAsync

public CompletableFuture deleteRemindersAsync(Map> reminderNames, CancellationToken cancellationToken)

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

上書き:

ReliableCollectionsActorStateProvider.deleteRemindersAsync(Map<ActorId, Collection<String>> reminderNames, CancellationToken cancellationToken)

パラメーター:

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

enumerateStateNamesAsync

public CompletableFuture> enumerateStateNamesAsync(ActorId actorId, CancellationToken cancellationToken)

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

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

上書き:

ReliableCollectionsActorStateProvider.enumerateStateNamesAsync(ActorId actorId, CancellationToken cancellationToken)

パラメーター:

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

getActorsAsync

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

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

発言： 次の値を使用

上書き:

ReliableCollectionsActorStateProvider.getActorsAsync(int numItemsToReturn, ContinuationToken continuationToken, CancellationToken cancellationToken)

パラメーター:

numItemsToReturn - 返される要求された項目の数。

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

initialize

public void initialize(ActorTypeInformation actorTypeInformation)

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

上書き:

ReliableCollectionsActorStateProvider.initialize(ActorTypeInformation actorTypeInformation)

パラメーター:

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

initialize

public void initialize(StatefulServiceInitializationParameters initializationParameters)

サービスの初期化情報を使用して、状態プロバイダー レプリカを初期化します。

発言：初期化中に複雑な処理を行う必要はありません。 OpenAsync では、コストのかかる初期化または実行時間の長い初期化を行う必要があります。

上書き:

ReliableCollectionsActorStateProvider.initialize(StatefulServiceInitializationParameters initializationParameters)

パラメーター:

initializationParameters - サービス名、パーティション ID、レプリカ ID、コード パッケージ情報などのサービス初期化情報。

loadRemindersAsync

public CompletableFuture loadRemindersAsync(CancellationToken cancellationToken)

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

上書き:

ReliableCollectionsActorStateProvider.loadRemindersAsync(CancellationToken cancellationToken)

パラメーター:

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

loadStateAsync

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

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

上書き:

ReliableCollectionsActorStateProvider.loadStateAsync(ActorId actorId, String stateName, CancellationToken cancellationToken)

パラメーター:

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

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

openAsync

public CompletableFuture openAsync(ReplicaOpenMode openMode, StatefulServicePartition partition, CancellationToken cancellationToken)

使用する状態プロバイダー レプリカを開きます。

発言：拡張状態プロバイダーの初期化タスクは、現時点で開始できます。

上書き:

ReliableCollectionsActorStateProvider.openAsync(ReplicaOpenMode openMode, StatefulServicePartition partition, CancellationToken cancellationToken)

パラメーター:

openMode - これが新しいレプリカか既存のレプリカかを示します。

partition - このレプリカが属するパーティション。

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

非同期オープン操作を表すタスク。 結果には、パーティション内の他の状態プロバイダー レプリカ間で状態をレプリケートするレプリケーターが含まれます。

reminderCallbackCompletedAsync

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

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

上書き:

ReliableCollectionsActorStateProvider.reminderCallbackCompletedAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken)

パラメーター:

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

reminder - 正常に完了したアクターアラーム。

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

戻り値:

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

removeActorAsync

public CompletableFuture removeActorAsync(ActorId actorId, CancellationToken cancellationToken)

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

上書き:

ReliableCollectionsActorStateProvider.removeActorAsync(ActorId actorId, CancellationToken cancellationToken)

パラメーター:

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

restoreAsync

public CompletableFuture restoreAsync(String backupFolderPath)

作成されたバックアップを復元します。

発言：安全な復元が実行されます。つまり、復元するデータが現在のレプリカの状態より前の場合にのみ復元が完了します。

上書き:

ReliableCollectionsActorStateProvider.restoreAsync(String backupFolderPath)

パラメーター:

backupFolderPath - レプリカの復元元のディレクトリ。 このパラメーターは、null、空、または空白のみを含めることはできません。 UNC パスも指定できます。

戻り値:

非同期復元操作を表すタスク。

restoreAsync

public CompletableFuture restoreAsync(String backupFolderPath, RestorePolicy restorePolicy, Duration timeout, CancellationToken cancellationToken)

作成されたバックアップを復元する

上書き:

ReliableCollectionsActorStateProvider.restoreAsync(String backupFolderPath, RestorePolicy restorePolicy, Duration timeout, CancellationToken cancellationToken)

パラメーター:

backupFolderPath - レプリカの復元元のディレクトリ。 このパラメーターは、null、空、または空白のみを含めることはできません。 UNC パスも指定できます。

restorePolicy - 復元ポリシー。

timeout - この操作のタイムアウト。

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

戻り値:

非同期復元操作を表すタスク。

saveReminderAsync

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

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

上書き:

ReliableCollectionsActorStateProvider.saveReminderAsync(ActorId actorId, ActorReminder reminder, CancellationToken cancellationToken)

パラメーター:

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

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

saveStateAsync

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

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

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

上書き:

ReliableCollectionsActorStateProvider.saveStateAsync(ActorId actorId, List<ActorStateChange> stateChanges, CancellationToken cancellationToken)

パラメーター:

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

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

cancellationToken -

CancellationToken 操作の取り消し状態を示す オブジェクト。

戻り値:

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

setOnDataLossCallback

public void setOnDataLossCallback(Function> onDataLossAsync)

データ損失の疑いがある場合に呼び出される関数

上書き:

ReliableCollectionsActorStateProvider.setOnDataLossCallback(Function<CancellationToken, CompletableFuture<Boolean>> onDataLossAsync)

パラメーター:

onDataLossAsync - データ損失の疑いのある処理の一部として呼び出される関数。 関数は CancellationToken を受け取り、イベントの非同期処理を表す CompletableFuture を返します。 true を返す場合は、レプリカの状態が復元されたことを示します。 False は、レプリカの状態が変更されていないことを示します。