StatefulServiceBase クラス

  • java.lang.Object
    • microsoft.servicefabric.services.runtime.StatefulServiceBase

public class StatefulServiceBase

Microsoft Service Fabric ベースのステートフル Reliable Service の基本クラスを表します。

コンストラクターの概要

コンストラクター 説明
StatefulServiceBase(StatefulServiceContext serviceContext, StateProviderReplica stateProviderReplica)

新しい StatefulService を作成します。

メソッドの概要

修飾子と型 メソッドと説明
CompletableFuture<?> backupAsync(BackupDescription backupDescription)

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

CompletableFuture<?> backupAsync(BackupDescription backupDescription, Duration timeout, CancellationToken cancellationToken)

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

List<ServiceReplicaListener> createServiceReplicaListeners()

サービス レプリカの通信リスナーを指定するには、このメソッドをオーバーライドします。 通信リスナーによって返されるエンドポイントは、ListenerName の JSON 文字列、{"Endpoints":{"Listener1":"Endpoint1"、"Listener2":"Endpoint2" ...}} などのエンドポイント文字列ペアとして格納されます。

Map<String, String> getAddresses()

(ListenerName、Endpoint) キーと値のペアとして、このサービス レプリカのすべてのアドレスの一覧を取得します。

StatefulServicePartition getPartition()

現在のサービス レプリカが属するサービス パーティション。

StatefulServiceContext getServiceContext()

このステートフル サービスが動作しているサービス コンテキストを取得します。 ReplicaId、PartitionId、ServiceName などの情報を提供します。

StateProviderReplica getStateProviderReplica()
void onAbort()

サービスが中止されていることを示す通知。 中止パスで取り消しが待機されないため、RunAsync はこのメソッドの実行と同時に実行される場合があります。

CompletableFuture<?> onChangeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken)

このメソッドは、 を完了 changeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken) する前の最後の手順として呼び出されます。 このレプリカの内部コンポーネントに対して ChangeRole が完了したことを通知するには、このメソッドをオーバーライドします。

CompletableFuture<?> onCloseAsync(CancellationToken cancellationToken)

このメソッドは、サービスを閉じる最後の手順として呼び出されます。 このレプリカの内部コンポーネントに対して Close が完了したことを通知するには、このメソッドをオーバーライドします。

CompletableFuture<Boolean> onDataLossAsync(RestoreContext context, CancellationToken cancellationToken)

このメソッドは、データ損失の疑いがある場合に呼び出されます。 このメソッドをオーバーライドして、データが失われた場合にサービスを復元できます。

CompletableFuture<?> onOpenAsync(ReplicaOpenMode openMode, CancellationToken cancellationToken)

このメソッドは、サービスを開く最後の手順として呼び出されます。 このレプリカの内部コンポーネントに対して Open が完了したことを通知するには、このメソッドをオーバーライドします。

CompletableFuture<?> runAsync(CancellationToken cancellationToken)

プライマリであり、書き込み状態の場合に実行される処理ループを実装するサービスは、このメソッドをロジックでオーバーライドするだけです。

void setAddresses(Map<String, String> addresses)

このサービス レプリカのすべてのアドレスの一覧を (ListenerName、Endpoint) キーと値のペアとして設定します。

void setPartition(StatefulServicePartition partition)

現在のサービス レプリカが属するサービス パーティション。

コンストラクターの詳細

StatefulServiceBase

protected StatefulServiceBase(StatefulServiceContext serviceContext, StateProviderReplica stateProviderReplica)

新しい StatefulService を作成します。

パラメーター:

serviceContext - StatefulServiceContextサービス コンテキストを表す 。
stateProviderReplica - StateProviderReplica信頼できる状態プロバイダー レプリカを表す 。

メソッドの詳細

backupAsync

public CompletableFuture backupAsync(BackupDescription backupDescription)

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

パラメーター:

backupDescription - BackupDescriptionバックアップ要求を記述する 。

戻り値:

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

backupAsync

public CompletableFuture backupAsync(BackupDescription backupDescription, Duration timeout, CancellationToken cancellationToken)

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

パラメーター:

backupDescription - BackupDescriptionバックアップ要求を記述する 。
timeout - この操作のタイムアウト。
cancellationToken - キャンセル要求を監視するためのトークン。

戻り値:

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

createServiceReplicaListeners

protected List createServiceReplicaListeners()

サービス レプリカの通信リスナーを指定するには、このメソッドをオーバーライドします。 通信リスナーによって返されるエンドポイントは、ListenerName の JSON 文字列、{"Endpoints":{"Listener1":"Endpoint1"、"Listener2":"Endpoint2" ...}} などのエンドポイント文字列ペアとして格納されます。

戻り値:

ServiceReplicaListeners の一覧

getAddresses

protected Map getAddresses()

(ListenerName、Endpoint) キーと値のペアとして、このサービス レプリカのすべてのアドレスの一覧を取得します。

戻り値:

Map(ListenerName、Endpoint) キーと値のペアとしてのアドレスのリストを含む 。

getPartition

protected StatefulServicePartition getPartition()

現在のサービス レプリカが属するサービス パーティション。

戻り値:

StatefulServicePartitionこのサービス レプリカが属するパーティションを表す 。

getServiceContext

public StatefulServiceContext getServiceContext()

このステートフル サービスが動作しているサービス コンテキストを取得します。 ReplicaId、PartitionId、ServiceName などの情報を提供します。

戻り値:

StatefulServiceContextサービス コンテキストを表す 。

getStateProviderReplica

protected StateProviderReplica getStateProviderReplica()

onAbort

protected void onAbort()

サービスが中止されていることを示す通知。 中止パスで取り消しが待機されないため、RunAsync はこのメソッドの実行と同時に実行される場合があります。

onChangeRoleAsync

protected CompletableFuture onChangeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken)

このメソッドは、 を完了 changeRoleAsync(ReplicaRole newRole, CancellationToken cancellationToken) する前の最後の手順として呼び出されます。 このレプリカの内部コンポーネントに対して ChangeRole が完了したことを通知するには、このメソッドをオーバーライドします。

パラメーター:

newRole - このサービス レプリカに対して。
cancellationToken -

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

戻り値:

CompletableFuture未処理の操作を表す 。

onCloseAsync

protected CompletableFuture onCloseAsync(CancellationToken cancellationToken)

このメソッドは、サービスを閉じる最後の手順として呼び出されます。 このレプリカの内部コンポーネントに対して Close が完了したことを通知するには、このメソッドをオーバーライドします。

パラメーター:

cancellationToken -

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

戻り値:

CompletableFuture未処理の操作を表す 。

onDataLossAsync

protected CompletableFuture onDataLossAsync(RestoreContext context, CancellationToken cancellationToken)

このメソッドは、データ損失の疑いがある場合に呼び出されます。 このメソッドをオーバーライドして、データが失われた場合にサービスを復元できます。

パラメーター:

context - RestoreContextサービスの復元に使用する 。
cancellationToken -

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

戻り値:

非同期復元操作を表す Task。 True は、状態が復元されたことを示します。 False は、レプリカの状態が変更されていないことを示します。

onOpenAsync

protected CompletableFuture onOpenAsync(ReplicaOpenMode openMode, CancellationToken cancellationToken)

このメソッドは、サービスを開く最後の手順として呼び出されます。 このレプリカの内部コンポーネントに対して Open が完了したことを通知するには、このメソッドをオーバーライドします。

パラメーター:

openMode - このサービス レプリカに対して。
cancellationToken -

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

戻り値:

CompletableFuture未処理の操作を表す 。

runAsync

protected CompletableFuture runAsync(CancellationToken cancellationToken)

プライマリであり、書き込み状態の場合に実行される処理ループを実装するサービスは、このメソッドをロジックでオーバーライドするだけです。

パラメーター:

cancellationToken -

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

戻り値:

CompletableFuture未処理の操作を表す 。

setAddresses

protected void setAddresses(Map addresses)

このサービス レプリカのすべてのアドレスの一覧を (ListenerName、Endpoint) キーと値のペアとして設定します。

パラメーター:

addresses - Map(ListenerName、Endpoint) キーと値のペアとしてのアドレスのリストを含む 。

setPartition

protected void setPartition(StatefulServicePartition partition)

現在のサービス レプリカが属するサービス パーティション。

パラメーター:

partition - StatefulServicePartitionこのサービス レプリカが属するパーティションを表す 。

適用対象