EventHubConsumerClient.ReadEventsAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ReadEventsAsync(CancellationToken) |
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために を |
| ReadEventsAsync(ReadEventOptions, CancellationToken) |
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために を |
| ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken) |
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために を |
ReadEventsAsync(CancellationToken)
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。
この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために をcancellationToken介した取り消しを要求する必要があるため、不確定な時間awaitブロックする可能性があります。 より決定的な最大待機時間が必要なシナリオでは、 を設定 MaximumWaitTime することをお勧めします。
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsAsync (System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)パラメーター
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。
戻り値
パーティション内の IAsyncEnumerable<T> イベントの反復処理に使用する 。
例外
別のリーダーが排他的所有権を EventHubConsumerClient アサートしたために、 がイベント ハブから読み取れない場合に発生します。 この場合、 EventHubsException.FailureReason は に ConsumerDisconnected設定されます。
注釈
この方法は、運用環境での使用には推奨されません。は EventProcessorClient 、より高いスループットではるかに堅牢なエクスペリエンスを提供しているため、運用シナリオのすべてのパーティションからイベントを読み取る場合に使用する必要があります。
このメソッドは、イテレーション中にパーティション間の公平性を保証しないことに注意することが重要です。各パーティションは、列挙子によって読み取られるイベントを発行するために競合します。 サービス通信によっては、パーティションごとのイベントのクラスタリングが存在する場合や、特定のパーティションまたはパーティションのサブセットに顕著なバイアスが発生する可能性があります。
イベントの各リーダーには、独立した反復子が表示されます。複数のリーダーがある場合、それぞれが競合するのではなく、処理するイベントの独自のコピーを受け取ります。
こちらもご覧ください
適用対象
ReadEventsAsync(ReadEventOptions, CancellationToken)
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。
この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために をcancellationToken介した取り消しを要求する必要があるため、不確定な時間awaitブロックする可能性があります。 より決定的な最大待機時間が必要なシナリオでは、 を設定 MaximumWaitTime することをお勧めします。
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsAsync (Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions, System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (readOptions As ReadEventOptions, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)パラメーター
- readOptions
- ReadEventOptions
読み取り動作の構成に使用するオプションのセット。指定しない場合は、既定値が使用されます。
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。
戻り値
パーティション内の IAsyncEnumerable<T> イベントの反復処理に使用する 。
例外
別のリーダーが排他的所有権を EventHubConsumerClient アサートしたために、 がイベント ハブから読み取れない場合に発生します。 この場合、 EventHubsException.FailureReason は に ConsumerDisconnected設定されます。
注釈
この方法は、運用環境での使用には推奨されません。は EventProcessorClient 、より高いスループットではるかに堅牢なエクスペリエンスを提供しているため、運用シナリオのすべてのパーティションからイベントを読み取る場合に使用する必要があります。
このメソッドは、イテレーション中にパーティション間の公平性を保証しないことに注意することが重要です。各パーティションは、列挙子によって読み取られるイベントを発行するために競合します。 サービス通信によっては、パーティションごとのイベントのクラスタリングが存在する場合や、特定のパーティションまたはパーティションのサブセットに顕著なバイアスが発生する可能性があります。
イベントの各リーダーには、独立した反復子が表示されます。複数のリーダーがある場合、それぞれが競合するのではなく、処理するイベントの独自のコピーを受け取ります。
こちらもご覧ください
適用対象
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。
この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために をcancellationToken介した取り消しを要求する必要があるため、不確定な時間awaitブロックする可能性があります。 より決定的な最大待機時間が必要なシナリオでは、 を設定 MaximumWaitTime することをお勧めします。
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsAsync (bool startReadingAtEarliestEvent, Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions = default, System.Threading.CancellationToken cancellationToken = default);abstract member ReadEventsAsync : bool * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsAsync : bool * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>Public Overridable Function ReadEventsAsync (startReadingAtEarliestEvent As Boolean, Optional readOptions As ReadEventOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)パラメーター
- startReadingAtEarliestEvent
- Boolean
true 各パーティションで使用可能な最初のイベントで読み取りを開始する場合。そうしないと、各パーティションの最後で読み取りが開始され、発行時に新しいイベントのみが表示されます。
- readOptions
- ReadEventOptions
読み取り動作の構成に使用するオプションのセット。指定しない場合は、既定値が使用されます。
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。
戻り値
パーティション内の IAsyncEnumerable<T> イベントの反復処理に使用する 。
例外
別のリーダーが排他的所有権を EventHubConsumerClient アサートしたために、 がイベント ハブから読み取れない場合に発生します。 この場合、 EventHubsException.FailureReason は に ConsumerDisconnected設定されます。
注釈
この方法は、運用環境での使用には推奨されません。は EventProcessorClient 、より高いスループットではるかに堅牢なエクスペリエンスを提供しているため、運用シナリオのすべてのパーティションからイベントを読み取る場合に使用する必要があります。
このメソッドは、イテレーション中にパーティション間の公平性を保証しないことに注意することが重要です。各パーティションは、列挙子によって読み取られるイベントを発行するために競合します。 サービス通信によっては、パーティションごとのイベントのクラスタリングが存在する場合や、特定のパーティションまたはパーティションのサブセットに顕著なバイアスが発生する可能性があります。
イベントの各リーダーには、独立した反復子が表示されます。複数のリーダーがある場合、それぞれが競合するのではなく、処理するイベントの独自のコピーを受け取ります。
こちらもご覧ください
適用対象
Azure SDK for .NET