ServiceBusReceiveActions.ReceiveMessagesAsync Methode

Definition

Namespace:

Microsoft.Azure.WebJobs.ServiceBus

Assembly:

Microsoft.Azure.WebJobs.Extensions.ServiceBus.dll

Paket:

Microsoft.Azure.WebJobs.Extensions.ServiceBus v5.16.0

Quelle:

ServiceBusReceiveActions.cs

Empfängt eine Liste von ServiceBusReceivedMessage von von der Entität. Diese Methode garantiert nicht, dass genaue maxMessages Nachrichten zurückgegeben werden, auch wenn nachrichten in der Warteschlange oder dem Thema verfügbar sind maxMessages . Nachrichten, die mit dieser Methode empfangen werden, unterliegen dem in definierten AutoCompleteMessagesVerhalten. Wenn diese Methode in einer Einzelnen-Dispatch-Funktion verwendet wird, unterliegen empfangene Nachrichten dem -MaxAutoLockRenewalDuration

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 für die erste Nachricht vor dem Zurückgeben einer leeren Liste angibt, wenn keine Nachrichten verfügbar sind. Wenn nicht angegeben, wird der TryTimeout verwendet.

cancellationToken

CancellationToken

Ein optionaler CancellationToken instance, um die Anforderung zum Abbrechen des Vorgangs zu signalisieren.

Gibt zurück

Task<IReadOnlyList<ServiceBusReceivedMessage>>

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