EventHubConsumerClient Classe

Definição

Namespace:

Azure.Messaging.EventHubs.Consumer

Assembly:

Azure.Messaging.EventHubs.dll

Pacote:

Azure.Messaging.EventHubs v5.11.3

Origem:

EventHubConsumerClient.cs

Um cliente responsável pela leitura EventData de um Hub de Eventos específico como membro de um grupo de consumidores específico.

Um consumidor pode ser exclusivo, o que declara a propriedade sobre partições associadas para o grupo de consumidores para garantir que apenas um consumidor desse grupo esteja lendo o da partição. Esses consumidores exclusivos às vezes são chamados de "Consumidores de Época".

Um consumidor também pode não ser exclusivo, permitindo que vários consumidores do mesmo grupo de consumidores leiam ativamente eventos de uma determinada partição. Esses consumidores não exclusivos às vezes são chamados de "Consumidores que não são épocas".

public class EventHubConsumerClient : IAsyncDisposable

type EventHubConsumerClient = class
    interface IAsyncDisposable

Public Class EventHubConsumerClient
Implements IAsyncDisposable

Herança

Object

EventHubConsumerClient

Implementações

IAsyncDisposable

Comentários

O EventHubConsumerClient é seguro para armazenar em cache e usar durante o tempo de vida de um aplicativo, que é a melhor prática quando o aplicativo lê eventos regularmente ou semestralmente. O consumidor é responsável por garantir o uso eficiente de rede, CPU e memória. Chamar ou CloseAsync(CancellationToken)DisposeAsync() como o aplicativo está sendo desligado garantirá que os recursos de rede e outros objetos não gerenciados sejam limpos corretamente.

Construtores

EventHubConsumerClient()	Inicializa uma nova instância da classe EventHubConsumerClient.
EventHubConsumerClient(String, EventHubConnection, EventHubConsumerClientOptions)	Inicializa uma nova instância da classe EventHubConsumerClient.
EventHubConsumerClient(String, String)	Inicializa uma nova instância da classe EventHubConsumerClient.
EventHubConsumerClient(String, String, EventHubConsumerClientOptions)	Inicializa uma nova instância da classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String)	Inicializa uma nova instância da classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String, AzureNamedKeyCredential, EventHubConsumerClientOptions)	Inicializa uma nova instância da classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String, AzureSasCredential, EventHubConsumerClientOptions)	Inicializa uma nova instância da classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String, EventHubConsumerClientOptions)	Inicializa uma nova instância da classe EventHubConsumerClient.
EventHubConsumerClient(String, String, String, TokenCredential, EventHubConsumerClientOptions)	Inicializa uma nova instância da classe EventHubConsumerClient.

Campos

DefaultConsumerGroupName

O nome do grupo de consumidores padrão no serviço hubs de eventos.

Propriedades

ConsumerGroup	O nome do grupo de consumidores ao qual esse consumidor está associado. Os eventos serão lidos somente no contexto desse grupo.
EventHubName	O nome do Hub de Eventos ao qual o consumidor está conectado, específico ao namespace dos Hubs de Eventos que o contém.
FullyQualifiedNamespace	O namespace dos Hubs de Eventos totalmente qualificado ao qual o consumidor está associado. É provável que isso seja semelhante a {yournamespace}.servicebus.windows.net.
Identifier	Um nome exclusivo usado para identificar esse consumidor.
IsClosed	Indica se isso EventHubConsumerClient foi ou não fechado.

Métodos

CloseAsync(CancellationToken)	Fecha o consumidor.
DisposeAsync()	Executa a tarefa necessária para limpo recursos usados pelo EventHubConsumerClient, incluindo garantir que o próprio cliente tenha sido fechado.
GetEventHubPropertiesAsync(CancellationToken)	Recupera informações sobre o Hub de Eventos ao qual a conexão está associada, incluindo o número de partições presentes e seus identificadores.
GetPartitionIdsAsync(CancellationToken)	Recupera o conjunto de identificadores para as partições de um Hub de Eventos.
GetPartitionPropertiesAsync(String, CancellationToken)	Recupera informações sobre uma partição específica para um Hub de Eventos, incluindo elementos que descrevem os eventos disponíveis no fluxo de eventos de partição.
ReadEventsAsync(Boolean, ReadEventOptions, CancellationToken)	Lê eventos de todas as partições do hub de eventos como uma enumerável assíncrona, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis. Esse enumerador pode bloquear por um período indeterminado de tempo para um await se os eventos não estiverem disponíveis na partição, exigindo o cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável definir o MaximumWaitTime para cenários em que um período de espera máximo mais determinístico é desejado.
ReadEventsAsync(CancellationToken)	Lê eventos de todas as partições do hub de eventos como uma enumerável assíncrona, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis. Esse enumerador pode bloquear por um período indeterminado de tempo para um await se os eventos não estiverem disponíveis na partição, exigindo o cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável definir o MaximumWaitTime para cenários em que um período de espera máximo mais determinístico é desejado.
ReadEventsAsync(ReadEventOptions, CancellationToken)	Lê eventos de todas as partições do hub de eventos como uma enumerável assíncrona, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis. Esse enumerador pode bloquear por um período indeterminado de tempo para um await se os eventos não estiverem disponíveis na partição, exigindo o cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável definir o MaximumWaitTime para cenários em que um período de espera máximo mais determinístico é desejado.
ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)	Lê eventos da partição solicitada como uma enumerável assíncrona, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis. Esse enumerador pode bloquear por um período indeterminado de tempo para um await se os eventos não estiverem disponíveis na partição, exigindo o cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável chamar a sobrecarga que aceita um conjunto de opções para configurar o comportamento de leitura para cenários em que um período de espera máximo mais determinístico é desejado.
ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)	Lê eventos da partição solicitada como uma enumerável assíncrona, permitindo que os eventos sejam iterados à medida que ficam disponíveis na partição, aguardando conforme necessário caso não haja eventos disponíveis. Esse enumerador pode bloquear por um período indeterminado de tempo para um await se os eventos não estiverem disponíveis na partição, exigindo o cancelamento por meio do a ser solicitado para retornar o cancellationToken controle. É recomendável definir o MaximumWaitTime para cenários em que um período de espera máximo mais determinístico é desejado.