EventProcessorClient.StopProcessingAsync(CancellationToken) メソッド

定義

名前空間:

Azure.Messaging.EventHubs

アセンブリ:

Azure.Messaging.EventHubs.Processor.dll

パッケージ:

Azure.Messaging.EventHubs.Processor v5.11.2

ソース:

EventProcessorClient.cs

イベントの処理を EventProcessorClient 停止するように を通知します。 プロセッサの実行中にこのメソッドを呼び出しても、アクションは実行されません。

public override System.Threading.Tasks.Task StopProcessingAsync (System.Threading.CancellationToken cancellationToken = default);

override this.StopProcessingAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Overrides Function StopProcessingAsync (Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

cancellationToken

CancellationToken

CancellationToken停止操作を取り消す要求を通知するインスタンス。 操作が正常に取り消された場合、 EventProcessorClient は実行を続けます。

戻り値

Task

注釈

停止すると、プロセッサは、処理を担当していたパーティションの所有権を更新し、Event Hubs サービスとの通信に使用されるネットワーク リソースをクリーンします。 その結果、このメソッドはネットワーク I/O を実行し、アクティブだったパーティションの読み取りが完了するまで待つ必要がある場合があります。

サービス呼び出しとネットワーク待機時間のため、このメソッドの呼び出しには、指定した MaximumWaitTime よりも少し時間がかかる場合があります。または、待機時間が構成されていない場合は、構成された再試行ポリシーの TryTimeout の期間がかかることがあります。