ServiceBusReceiver Classe

Définition

Espace de noms:

Azure.Messaging.ServiceBus

Assembly:

Azure.Messaging.ServiceBus.dll

Paquet:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusReceiver.cs

est ServiceBusReceiver responsable de la ServiceBusReceivedMessage réception et du règlement des messages des files d’attente et des abonnements. Il est construit en appelant CreateReceiver(String, ServiceBusReceiverOptions).

public class ServiceBusReceiver : IAsyncDisposable

type ServiceBusReceiver = class
    interface IAsyncDisposable

Public Class ServiceBusReceiver
Implements IAsyncDisposable

Héritage

Object

ServiceBusReceiver

Dérivé

Azure.Messaging.ServiceBus.ServiceBusSessionReceiver

Implémente

IAsyncDisposable

Remarques

ServiceBusReceiver Le est sûr à mettre en cache et à utiliser pendant la durée de vie d’une application ou jusqu’à ce que le ServiceBusClient par lequel il a été créé soit supprimé. La mise en cache du récepteur est recommandée lorsque l’application consomme des messages régulièrement ou semi-régulièrement. Le récepteur est chargé de garantir une utilisation efficace du réseau, du processeur et de la mémoire. L’appel DisposeAsync() du associé ServiceBusClient lorsque l’application s’arrête garantit que les ressources réseau et autres objets non managés utilisés par le récepteur sont correctement nettoyés.

Constructeurs

ServiceBusReceiver()	Initialise une nouvelle instance de la ServiceBusReceiver classe pour les moqueries.
ServiceBusReceiver(ServiceBusClient, String, ServiceBusReceiverOptions)	Initialise une nouvelle instance de la classe pour une ServiceBusReceiver utilisation avec des types dérivés.
ServiceBusReceiver(ServiceBusClient, String, String, ServiceBusReceiverOptions)	Initialise une nouvelle instance de la classe pour une ServiceBusReceiver utilisation avec des types dérivés.

Propriétés

EntityPath	Chemin d’accès de l’entité Service Bus à laquelle le récepteur est connecté, spécifique à l’espace de noms Service Bus qui le contient.
FullyQualifiedNamespace	Espace de noms Service Bus complet auquel le récepteur est associé. Cela est susceptible d’être similaire à {yournamespace}.servicebus.windows.net.
Identifier	Nom utilisé pour identifier le client récepteur. Si null ou vide, une valeur unique aléatoire sera utilisée.
IsClosed	Indique si cette ServiceBusReceiver opération a été fermée ou non.
PrefetchCount	Nombre de messages qui seront vivement demandés à partir des files d’attente ou des abonnements et mis en file d’attente localement, sans tenir compte du fait qu’un traitement est actuellement actif, destiné à optimiser le débit en permettant au destinataire de recevoir à partir d’un cache local plutôt que d’attendre une demande de service
ReceiveMode	ReceiveMode utilisé pour spécifier la façon dont les messages sont reçus.

Méthodes

AbandonMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Abandonne un ServiceBusReceivedMessage. Cela rend le message à nouveau disponible pour un traitement immédiat, car le verrou sur le message détenu par le destinataire sera libéré.
CloseAsync(CancellationToken)	Effectue la tâche nécessaire pour propre ressources utilisées par .ServiceBusReceiver
CompleteMessageAsync(ServiceBusReceivedMessage, CancellationToken)	Termine un .ServiceBusReceivedMessage Cela supprime le message du service.
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Déplace un message vers la sous-file d’attente de lettres mortes.
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, String, String, CancellationToken)	Déplace un message vers la sous-file d’attente de lettres mortes.
DeadLetterMessageAsync(ServiceBusReceivedMessage, String, String, CancellationToken)	Déplace un message vers la sous-file d’attente de lettres mortes.
DeferMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	Indique que le destinataire souhaite différer le traitement du message.
DisposeAsync()	Effectue la tâche nécessaire pour propre ressources utilisées par .ServiceBusReceiver Cela équivaut à appeler CloseAsync(CancellationToken).
PeekMessageAsync(Nullable<Int64>, CancellationToken)	Extrait le suivant actif ServiceBusReceivedMessage sans modifier l’état du récepteur ou de la source du message.
PeekMessagesAsync(Int32, Nullable<Int64>, CancellationToken)	est ServiceBusReceiver responsable de la ServiceBusReceivedMessage réception et du règlement des messages des files d’attente et des abonnements. Il est construit en appelant CreateReceiver(String, ServiceBusReceiverOptions).
ReceiveDeferredMessageAsync(Int64, CancellationToken)	Reçoit un message différé identifié par sequenceNumber.
ReceiveDeferredMessagesAsync(IEnumerable<Int64>, CancellationToken)	Reçoit une liste de messages différés identifiés par sequenceNumbers.
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	Reçoit un ServiceBusReceivedMessage de l’entité à l’aide du ReceiveMode mode . ReceiveMode par défaut en mode PeekLock.
ReceiveMessagesAsync(CancellationToken)	Reçoit des messages en tant que énumérable asynchrone à partir de l’entité à l’aide du ReceiveMode mode . ReceiveMode par défaut en mode PeekLock. Les messages sont reçus de l’entité lorsque IAsyncEnumerable est itéré. Si aucun message n’est disponible, cette méthode continue l’interrogation jusqu’à ce que les messages soient disponibles, c’est-à-dire qu’elle ne retourne jamais null.
ReceiveMessagesAsync(Int32, Nullable<TimeSpan>, CancellationToken)	Reçoit la liste de de l’entité ServiceBusReceivedMessage en utilisant le ReceiveMode mode . ReceiveMode par défaut en mode PeekLock. Cette méthode ne garantit pas de renvoyer des messages exacts maxMessages , même s’il existe maxMessages des messages disponibles dans la file d’attente ou la rubrique.
RenewMessageLockAsync(ServiceBusReceivedMessage, CancellationToken)	Renouvelle le verrou sur le message. Le verrou sera renouvelé en fonction du paramètre spécifié dans la file d’attente.