EventHubConsumerClient Clase

Definición

Espacio de nombres:

Azure.Messaging.EventHubs.Consumer

Ensamblado:

Azure.Messaging.EventHubs.dll

Paquete:

Azure.Messaging.EventHubs v5.11.3

Source:

EventHubConsumerClient.cs

Un cliente responsable de leer EventData desde un centro de eventos específico como miembro de un grupo de consumidores específico.

Un consumidor puede ser exclusivo, que afirma la propiedad sobre las particiones asociadas para el grupo de consumidores para asegurarse de que solo un consumidor de ese grupo está leyendo desde la partición. Estos consumidores exclusivos a veces se conocen como "Consumidores de época".

Un consumidor también puede ser no exclusivo, lo que permite que varios consumidores del mismo grupo de consumidores lean activamente los eventos de una partición determinada. Estos consumidores no exclusivos a veces se conocen como "Consumidores no de época".

public class EventHubConsumerClient : IAsyncDisposable

type EventHubConsumerClient = class
    interface IAsyncDisposable

Public Class EventHubConsumerClient
Implements IAsyncDisposable

Herencia

Object

EventHubConsumerClient

Implementaciones

IAsyncDisposable

Comentarios

EventHubConsumerClient es seguro almacenar en caché y usar durante la vigencia de una aplicación, que es el procedimiento recomendado cuando la aplicación lee eventos periódicamente o semestralmente. El consumidor es responsable de garantizar un uso eficaz de la red, la CPU y la memoria. Al llamar a o CloseAsync(CancellationToken)DisposeAsync() a medida que se cierra la aplicación, se asegurará de que los recursos de red y otros objetos no administrados se limpien correctamente.

Constructores

EventHubConsumerClient()	Inicializa una nueva instancia de la clase EventHubConsumerClient.
EventHubConsumerClient(String, EventHubConnection, EventHubConsumerClientOptions)	Inicializa una nueva instancia de la clase EventHubConsumerClient.
EventHubConsumerClient(String, String)	Inicializa una nueva instancia de la clase EventHubConsumerClient.
EventHubConsumerClient(String, String, EventHubConsumerClientOptions)	Inicializa una nueva instancia de la clase EventHubConsumerClient.
EventHubConsumerClient(String, String, String)	Inicializa una nueva instancia de la clase EventHubConsumerClient.
EventHubConsumerClient(String, String, String, AzureNamedKeyCredential, EventHubConsumerClientOptions)	Inicializa una nueva instancia de la clase EventHubConsumerClient.
EventHubConsumerClient(String, String, String, AzureSasCredential, EventHubConsumerClientOptions)	Inicializa una nueva instancia de la clase EventHubConsumerClient.
EventHubConsumerClient(String, String, String, EventHubConsumerClientOptions)	Inicializa una nueva instancia de la clase EventHubConsumerClient.
EventHubConsumerClient(String, String, String, TokenCredential, EventHubConsumerClientOptions)	Inicializa una nueva instancia de la clase EventHubConsumerClient.

Campos

DefaultConsumerGroupName

Nombre del grupo de consumidores predeterminado en el servicio Event Hubs.

Propiedades

ConsumerGroup	Nombre del grupo de consumidores al que está asociado este consumidor. Los eventos serán de solo lectura en el contexto de este grupo.
EventHubName	Nombre del centro de eventos al que está conectado el consumidor, específico del espacio de nombres de Event Hubs que lo contiene.
FullyQualifiedNamespace	Espacio de nombres completo de Event Hubs al que está asociado el consumidor. Es probable que sea similar a {yournamespace}.servicebus.windows.net.
Identifier	Nombre único que se usa para identificar a este consumidor.
IsClosed	Indica si se EventHubConsumerClient ha cerrado o no.

Métodos

CloseAsync(CancellationToken)	Cierra el consumidor.
DisposeAsync()	Realiza la tarea necesaria para limpiar los recursos utilizados por , EventHubConsumerClientincluida la garantía de que el propio cliente se ha cerrado.
GetEventHubPropertiesAsync(CancellationToken)	Recupera información sobre el centro de eventos al que está asociada la conexión, incluido el número de particiones presentes y sus identificadores.
GetPartitionIdsAsync(CancellationToken)	Recupera el conjunto de identificadores para las particiones de un centro de eventos.
GetPartitionPropertiesAsync(String, CancellationToken)	Recupera información sobre una partición específica para un centro de eventos, incluidos los elementos que describen los eventos disponibles en el flujo de eventos de partición.
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)	Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles. Este enumerador puede bloquear durante un período de tiempo indeterminado para un await si los eventos no están disponibles en la partición, lo que requiere la cancelación a través del objeto cancellationToken que se va a solicitar para devolver el control. Se recomienda establecer para MaximumWaitTime escenarios en los que se desee un período de espera máximo más determinista.
ReadEventsAsync(CancellationToken)	Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles. Este enumerador puede bloquear durante un período de tiempo indeterminado para un await si los eventos no están disponibles en la partición, lo que requiere la cancelación a través del objeto cancellationToken que se va a solicitar para devolver el control. Se recomienda establecer para MaximumWaitTime escenarios en los que se desee un período de espera máximo más determinista.
ReadEventsAsync(ReadEventOptions, CancellationToken)	Lee los eventos de todas las particiones del centro de eventos como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles. Este enumerador puede bloquear durante un período de tiempo indeterminado para un await si los eventos no están disponibles en la partición, lo que requiere la cancelación a través del objeto cancellationToken que se va a solicitar para devolver el control. Se recomienda establecer para MaximumWaitTime escenarios en los que se desee un período de espera máximo más determinista.
ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)	Lee los eventos de la partición solicitada como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles. Este enumerador puede bloquear durante un período de tiempo indeterminado para un await si los eventos no están disponibles en la partición, lo que requiere la cancelación a través del objeto cancellationToken que se va a solicitar para devolver el control. Se recomienda llamar a la sobrecarga que acepta un conjunto de opciones para configurar el comportamiento de lectura en escenarios en los que se desea un período de espera máximo más determinista.
ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)	Lee los eventos de la partición solicitada como enumerable asincrónico, lo que permite iterar los eventos a medida que están disponibles en la partición, esperando según sea necesario si no hay eventos disponibles. Este enumerador puede bloquear durante un período de tiempo indeterminado para un await si los eventos no están disponibles en la partición, lo que requiere la cancelación a través del objeto cancellationToken que se va a solicitar para devolver el control. Se recomienda establecer para MaximumWaitTime escenarios en los que se desee un período de espera máximo más determinista.