SubscriptionEventHandlers interface

パッケージ:

@azure/event-hubs

Event Hub からイベントを受信するために メソッドが呼び出されたときに subscribe() によって呼び出される、ユーザーがEventHubConsumerClient実装する関数を記述するインターフェイス。

プロパティ

processClose	サブスクリプションが EventHubConsumerClient パーティションからのイベントの読み取りを停止するたびに呼び出される関数。 このパーティションの情報は、 関数 processCloseに渡された でPartitionContext使用できます。 CloseReasonこの関数に渡された が の場合、OwnershipLost同じコンシューマー グループを使用して、別のサブスクリプションが同じパーティションからの読み取りを引き継いでいます。 これは、アプリケーションの複数のインスタンスが実行されていて、 をクライアントに渡して負荷分散している場合に想定されます CheckpointStore 。 CloseReasonが の場合は、 がShutdown呼び出されたか、エラーが発生したことを示subscription.close()します。 を介して subscription.close()サブスクリプションが明示的に閉じられている場合を除き、サブスクリプションはパーティションの最後のチェックポイントからイベントの読み取りを再開しようとします。
processError	イベントの受信時またはメソッドに渡されたユーザー指定関数の実行時に発生するエラーに対して subscribe() によってEventHubConsumerClient呼び出される関数。 この関数に渡される は PartitionContext 、エラーがスローされたときに処理されていたパーティションを示します。 パーティションからのイベントの処理の外部でエラーがスローされた場合 (負荷分散の実行に失敗した場合など) partitionId 、コンテキスト上の は空の文字列になります。 クライアントがこの関数の実行を完了すると、 partitionClose 関数が呼び出されます。
processEvents	一連のイベントを受信したときに呼 EventHubConsumerClient び出される関数。 PartitionContextこの関数に渡される を使用して、読み取り元のパーティションを決定できます。 updateCheckpoint()コンテキストの メソッドを使用して、 内のCheckpointStoreチェックポイントを更新できます (クライアントにチェックポイントが指定されている場合)。 再起動またはエラー復旧が発生した場合にクライアントがこのようなチェックポイントから再起動できるように、処理されたイベントをマークするには、頻繁にこれを使用します。 注: 受信したイベントが空の配列になる可能性があります。 これは、 で maxWaitTimeInSeconds受信する新しいイベントがない場合に発生する可能性があります。既定では 60 秒です。 はmaxWaitTimeInSeconds、 に渡された subscribe()にoptions設定することで変更できます。
processInitialize	サブスクリプションが EventHubConsumerClient パーティションからの読み取りを開始しようとするたびに呼び出される関数。 PartitionContextこの関数に渡される を使用して、読み取りを行うパーティションを決定できます。 クライアントは、この関数の実行が完了した後 (指定されている場合) にのみ、パーティションのイベントの受信を開始します。 したがって、非同期タスクを含むセットアップ作業を実行するには、この関数を使用します。

プロパティの詳細

processClose

サブスクリプションが EventHubConsumerClient パーティションからのイベントの読み取りを停止するたびに呼び出される関数。 このパーティションの情報は、 関数 processCloseに渡された でPartitionContext使用できます。

CloseReasonこの関数に渡された が の場合、OwnershipLost同じコンシューマー グループを使用して、別のサブスクリプションが同じパーティションからの読み取りを引き継いでいます。 これは、アプリケーションの複数のインスタンスが実行されていて、 をクライアントに渡して負荷分散している場合に想定されます CheckpointStore 。

CloseReasonが の場合は、 がShutdown呼び出されたか、エラーが発生したことを示subscription.close()します。 を介して subscription.close()サブスクリプションが明示的に閉じられている場合を除き、サブスクリプションはパーティションの最後のチェックポイントからイベントの読み取りを再開しようとします。

processClose?: ProcessCloseHandler

プロパティ値

ProcessCloseHandler

processError

イベントの受信時またはメソッドに渡されたユーザー指定関数の実行時に発生するエラーに対して subscribe() によってEventHubConsumerClient呼び出される関数。

この関数に渡される は PartitionContext 、エラーがスローされたときに処理されていたパーティションを示します。 パーティションからのイベントの処理の外部でエラーがスローされた場合 (負荷分散の実行に失敗した場合など) partitionId 、コンテキスト上の は空の文字列になります。

クライアントがこの関数の実行を完了すると、 partitionClose 関数が呼び出されます。

processError: ProcessErrorHandler

プロパティ値

ProcessErrorHandler

processEvents

一連のイベントを受信したときに呼 EventHubConsumerClient び出される関数。 PartitionContextこの関数に渡される を使用して、読み取り元のパーティションを決定できます。

updateCheckpoint()コンテキストの メソッドを使用して、 内のCheckpointStoreチェックポイントを更新できます (クライアントにチェックポイントが指定されている場合)。 再起動またはエラー復旧が発生した場合にクライアントがこのようなチェックポイントから再起動できるように、処理されたイベントをマークするには、頻繁にこれを使用します。

注: 受信したイベントが空の配列になる可能性があります。 これは、 で maxWaitTimeInSeconds受信する新しいイベントがない場合に発生する可能性があります。既定では 60 秒です。 はmaxWaitTimeInSeconds、 に渡された subscribe()にoptions設定することで変更できます。

processEvents: ProcessEventsHandler

プロパティ値

ProcessEventsHandler

processInitialize

サブスクリプションが EventHubConsumerClient パーティションからの読み取りを開始しようとするたびに呼び出される関数。 PartitionContextこの関数に渡される を使用して、読み取りを行うパーティションを決定できます。

クライアントは、この関数の実行が完了した後 (指定されている場合) にのみ、パーティションのイベントの受信を開始します。 したがって、非同期タスクを含むセットアップ作業を実行するには、この関数を使用します。

processInitialize?: ProcessInitializeHandler

プロパティ値

ProcessInitializeHandler