ProcessorReceiveActions.ReceiveMessagesAsync Methode

Definition

Namespace:

Azure.Messaging.ServiceBus

Assembly:

Azure.Messaging.ServiceBus.dll

Paket:

Azure.Messaging.ServiceBus v7.17.5

Quelle:

ProcessorReceiveActions.cs

Empfängt eine Liste von von der Entität mithilfe ServiceBusReceiveMode des ServiceBusReceivedMessage in ReceiveModekonfigurierten Modus, der standardmäßig im PeekLock-Modus verwendet wird. Diese Methode garantiert nicht, dass genaue maxMessages Nachrichten zurückgegeben werden, auch wenn in der Warteschlange oder dem Thema Nachrichten verfügbar sind maxMessages . Nachrichten, die mit dieser Methode empfangen werden, unterliegen dem in den Eigenschaften und MaxAutoLockRenewalDuration definierten AutoCompleteMessages Verhalten.

public virtual System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>> ReceiveMessagesAsync (int maxMessages, TimeSpan? maxWaitTime = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>
override this.ReceiveMessagesAsync : int * Nullable<TimeSpan> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>>

Public Overridable Function ReceiveMessagesAsync (maxMessages As Integer, Optional maxWaitTime As Nullable(Of TimeSpan) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IReadOnlyList(Of ServiceBusReceivedMessage))

Parameter

maxMessages

Int32

Die maximale Anzahl von Nachrichten, die empfangen werden.

maxWaitTime

Nullable<TimeSpan>

Ein optionaler TimeSpan Wert, der die maximale Wartezeit auf die erste Nachricht angibt, bevor eine leere Liste zurückgegeben wird, wenn keine Nachrichten verfügbar sind. Wenn nicht angegeben, wird verwendet TryTimeout .

cancellationToken

CancellationToken

Ein optionaler CancellationToken instance, um der Anforderung zu signalisieren, den Vorgang abzubrechen.

Gibt zurück

Task<IReadOnlyList<ServiceBusReceivedMessage>>

Liste der empfangenen Nachrichten. Gibt eine leere Liste zurück, wenn keine Nachricht gefunden wird.