PartitionReceiver.ReceiveBatchAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| ReceiveBatchAsync(Int32, CancellationToken) |
このクライアントが関連付けられている Event Hub パーティションから の EventData バッチを受信します。 |
| ReceiveBatchAsync(Int32, TimeSpan, CancellationToken) |
このクライアントが関連付けられている Event Hub パーティションから の EventData バッチを受信します。 |
ReceiveBatchAsync(Int32, CancellationToken)
このクライアントが関連付けられている Event Hub パーティションから の EventData バッチを受信します。
public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, System.Threading.CancellationToken cancellationToken = default);abstract member ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))パラメーター
- maximumEventCount
- Int32
このバッチで受信するメッセージの最大数。
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。
戻り値
このクライアントが EventData 関連付けられている Event Hub パーティションからの のバッチ。 イベントが存在しない場合は、空の列挙可能な が返されます。
例外
要求された が 1 未満の場合に maximumEventCount 発生します。
別のリーダーが排他的所有権を PartitionReceiver アサートしたために、 が要求された Event Hub パーティションから読み取れない場合に発生します。 この場合、 EventHubsException.FailureReason は に ConsumerDisconnected設定されます。
注釈
プリフェッチ キューでイベントが使用可能な場合は、Event Hubs サービスからの追加のイベントが要求された を満たすのを待たずに、可能な限り迅速にバッチを形成するために使用されます maximumEventCount。 プリフェッチで使用可能なイベントがない場合、受信側は、アクティブな再試行ポリシーで によって TryTimeout 指定された期間まで、イベントがサービスから読み取られるのを待機します。 イベントが使用可能になると、すぐにバッチを形成するために使用されます。
適用対象
ReceiveBatchAsync(Int32, TimeSpan, CancellationToken)
このクライアントが関連付けられている Event Hub パーティションから の EventData バッチを受信します。
public virtual System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Azure.Messaging.EventHubs.EventData>> ReceiveBatchAsync (int maximumEventCount, TimeSpan maximumWaitTime, System.Threading.CancellationToken cancellationToken = default);abstract member ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>
override this.ReceiveBatchAsync : int * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Azure.Messaging.EventHubs.EventData>>Public Overridable Function ReceiveBatchAsync (maximumEventCount As Integer, maximumWaitTime As TimeSpan, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of EventData))パラメーター
- maximumEventCount
- Int32
このバッチで受信するメッセージの最大数。
- maximumWaitTime
- TimeSpan
プリフェッチ キューからイベントを読み取ることができる場合に、イベントが使用可能になるまで待機する最大時間。
- cancellationToken
- CancellationToken
操作を取り消す要求を通知する省略可能 CancellationToken な インスタンス。
戻り値
このクライアントが EventData 関連付けられている Event Hub パーティションからの のバッチ。 イベントが存在しない場合は、空の列挙可能な が返されます。
例外
要求された が 1 未満の場合に maximumEventCount 発生します。
別のリーダーが排他的所有権を PartitionReceiver アサートしたために、 が要求された Event Hub パーティションから読み取れない場合に発生します。 この場合、 EventHubsException.FailureReason は に ConsumerDisconnected設定されます。
注釈
プリフェッチ キューでイベントが使用可能な場合は、Event Hubs サービスからの追加のイベントが要求された を満たすのを待たずに、可能な限り迅速にバッチを形成するために使用されます maximumEventCount。 プリフェッチで使用可能なイベントがない場合、受信側は、イベントがサービスから読み取られるまで を maximumWaitTime 待機します。 イベントが使用可能になると、すぐにバッチを形成するために使用されます。
適用対象
Azure SDK for .NET