EventHubConsumerClient クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
特定のコンシューマー グループのメンバーとして特定のイベント ハブからの読み取 EventData りを担当するクライアント。
コンシューマーは排他的であり、コンシューマー グループの関連付けられたパーティションに対して所有権をアサートし、そのグループの 1 つのコンシューマーのみがパーティションから を読み取れるようにします。 これらの排他的コンシューマーは、"エポック コンシューマー" と呼ばれることもあります。
コンシューマーは非排他的な場合もあり、同じコンシューマー グループの複数のコンシューマーが特定のパーティションからイベントをアクティブに読み取れるようにすることができます。 これらの非排他的コンシューマーは、"非エポック コンシューマー" と呼ばれることもあります。
public class EventHubConsumerClient : IAsyncDisposabletype EventHubConsumerClient = class
interface IAsyncDisposablePublic Class EventHubConsumerClient
Implements IAsyncDisposable- 継承
-
EventHubConsumerClient
- 実装
注釈
EventHubConsumerClientは、アプリケーションの有効期間中はキャッシュして使用しても安全です。これは、アプリケーションがイベントを定期的または半定期的に読み取る場合のベスト プラクティスです。 コンシューマーは、効率的なネットワーク、CPU、メモリの使用を確保する責任があります。 アプリケーションのシャットダウン時に または DisposeAsync() をCloseAsync(CancellationToken)呼び出すと、ネットワーク リソースやその他のアンマネージド オブジェクトが適切にクリーンアップされます。
コンストラクター
フィールド
| DefaultConsumerGroupName |
Event Hubs サービスの既定のコンシューマー グループの名前。 |
プロパティ
| ConsumerGroup |
このコンシューマーが関連付けられているコンシューマー グループの名前。 イベントは、このグループのコンテキストでのみ読み取られます。 |
| EventHubName |
コンシューマーが接続されている Event Hub の名前。コンシューマーが含まれる Event Hubs 名前空間に固有です。 |
| FullyQualifiedNamespace |
コンシューマーが関連付けられている完全修飾 Event Hubs 名前空間。 これは と似ている |
| Identifier |
このコンシューマーを識別するために使用される一意の名前。 |
| IsClosed |
これが EventHubConsumerClient 閉じられているかどうかを示します。 |
メソッド
| CloseAsync(CancellationToken) |
コンシューマーを閉じます。 |
| DisposeAsync() |
によって使用されるリソースをクリーンするために必要なタスクをEventHubConsumerClient実行します。これには、クライアント自体が閉じられているかの確認が含まれます。 |
| GetEventHubPropertiesAsync(CancellationToken) |
存在するパーティションの数とその識別子など、接続が関連付けられているイベント ハブに関する情報を取得します。 |
| GetPartitionIdsAsync(CancellationToken) |
イベント ハブのパーティションの識別子のセットを取得します。 |
| GetPartitionPropertiesAsync(String, CancellationToken) |
パーティション イベント ストリームで使用可能なイベントを記述する要素など、Event Hub の特定のパーティションに関する情報を取得します。 |
| ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken) |
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために を |
| ReadEventsAsync(CancellationToken) |
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために を |
| ReadEventsAsync(ReadEventOptions, CancellationToken) |
イベント ハブのすべてのパーティションからイベントを非同期列挙可能として読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために を |
| ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken) |
要求されたパーティションから非同期列挙可能としてイベントを読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために を |
| ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken) |
要求されたパーティションから非同期列挙可能としてイベントを読み取り、パーティションで使用可能になったときにイベントを反復処理し、使用可能なイベントがない場合は必要に応じて待機できるようにします。 この列挙子は、 がパーティションでイベントを使用できない場合に、制御を返すために を |
適用対象
Azure SDK for .NET