EventHubConsumerClient.ReadEventsFromPartitionAsync Método

Definición

Espacio de nombres:

Azure.Messaging.EventHubs.Consumer

Ensamblado:

Azure.Messaging.EventHubs.dll

Paquete:

Azure.Messaging.EventHubs v5.11.3

Sobrecargas

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.

ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)

Source:

EventHubConsumerClient.cs

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.

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsFromPartitionAsync (string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition startingPosition, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>

Public Overridable Function ReadEventsFromPartitionAsync (partitionId As String, startingPosition As EventPosition, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)

Parámetros

partitionId

String

Identificador de la partición del centro de eventos desde la que se recibirán los eventos.

startingPosition

EventPosition

Posición dentro de la partición donde el consumidor debe comenzar a leer eventos.

cancellationToken

CancellationToken

Una instancia opcional CancellationToken para indicar la solicitud para cancelar la operación.

Devoluciones

IAsyncEnumerable<PartitionEvent>

que IAsyncEnumerable<T> se va a usar para recorrer en iteración los eventos de la partición.

Excepciones

EventHubsException

Se produce cuando no EventHubConsumerClient se puede leer desde la partición del centro de eventos solicitada debido a que otro lector ha declarado la propiedad exclusiva. En este caso, se establecerá ConsumerDisconnecteden EventHubsException.FailureReason .

Comentarios

Cada lector de eventos se presenta con un iterador independiente; si hay varios lectores, cada uno recibe su propia copia de un evento que se va a procesar, en lugar de competir por ellos.

Consulte también

• ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

ReadEventsFromPartitionAsync(String, EventPosition, ReadEventOptions, CancellationToken)

Source:

EventHubConsumerClient.cs

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.

public virtual System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent> ReadEventsFromPartitionAsync (string partitionId, Azure.Messaging.EventHubs.Consumer.EventPosition startingPosition, Azure.Messaging.EventHubs.Consumer.ReadEventOptions readOptions, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>
override this.ReadEventsFromPartitionAsync : string * Azure.Messaging.EventHubs.Consumer.EventPosition * Azure.Messaging.EventHubs.Consumer.ReadEventOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Messaging.EventHubs.Consumer.PartitionEvent>

Public Overridable Function ReadEventsFromPartitionAsync (partitionId As String, startingPosition As EventPosition, readOptions As ReadEventOptions, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of PartitionEvent)

Parámetros

partitionId

String

Identificador de la partición del centro de eventos desde la que se recibirán los eventos.

startingPosition

EventPosition

Posición dentro de la partición donde el consumidor debe comenzar a leer eventos.

readOptions

ReadEventOptions

Conjunto de opciones que se van a usar para configurar el comportamiento de lectura; si no se especifican los valores predeterminados se usarán.

cancellationToken

CancellationToken

Una instancia opcional CancellationToken para indicar la solicitud para cancelar la operación.

Devoluciones

IAsyncEnumerable<PartitionEvent>

que IAsyncEnumerable<T> se va a usar para recorrer en iteración los eventos de la partición.

Excepciones

EventHubsException

Se produce cuando no EventHubConsumerClient se puede leer desde la partición del centro de eventos solicitada debido a que otro lector ha declarado la propiedad exclusiva. En este caso, se establecerá ConsumerDisconnecteden EventHubsException.FailureReason .

Comentarios

Cada lector de eventos se presenta con un iterador independiente; si hay varios lectores, cada uno recibe su propia copia de un evento que se va a procesar, en lugar de competir por ellos.

Consulte también

• ReadEventsFromPartitionAsync(String, EventPosition, CancellationToken)