MessageReceiver Classe

Définition

Espace de noms:

Microsoft.Azure.ServiceBus.Core

Assembly:

Microsoft.Azure.ServiceBus.dll

Paquet:

Microsoft.Azure.ServiceBus v5.2.0

Source:

MessageReceiver.cs

MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.

public class MessageReceiver : Microsoft.Azure.ServiceBus.ClientEntity, Microsoft.Azure.ServiceBus.Core.IMessageReceiver

type MessageReceiver = class
    inherit ClientEntity
    interface IMessageReceiver
    interface IReceiverClient
    interface IClientEntity

Public Class MessageReceiver
Inherits ClientEntity
Implements IMessageReceiver

Héritage

Object

ClientEntity

MessageReceiver

Implémente

IMessageReceiver IReceiverClient IClientEntity

Exemples

Créer un messageReceiver pour recevoir un message d’un abonnement

IMessageReceiver messageReceiver = new MessageReceiver(
    namespaceConnectionString,
    EntityNameHelper.FormatSubscriptionPath(topicName, subscriptionName),
    ReceiveMode.PeekLock);

Recevez un message de l’abonnement.

var message = await messageReceiver.ReceiveAsync();
await messageReceiver.CompleteAsync(message.SystemProperties.LockToken);

Remarques

MessageReceiver fournit des fonctionnalités avancées qui ne se trouvent pas dans ou QueueClientSubscriptionClient. Pour instance, ReceiveAsync(), qui vous permet de recevoir des messages à la demande, mais vous oblige également à renouveler manuellement les verrous à l’aide RenewLockAsync(Message)de . Il utilise le protocole AMQP pour communiquer avec le service.

Constructeurs

MessageReceiver(ServiceBusConnection, String, ReceiveMode, RetryPolicy, Int32)	Crée un message AMQP MessageReceiver sur un objet donné ServiceBusConnection
MessageReceiver(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy, Int32)	Crée un messageReceiver à partir d’un ServiceBusConnectionStringBuilder.
MessageReceiver(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy, Int32)	Crée un messageReceiver à partir d’un point de terminaison, d’un chemin d’entité et d’un fournisseur de jetons spécifiés.
MessageReceiver(String, String, ReceiveMode, RetryPolicy, Int32)	Crée un messageReceiver à partir d’une chaîne de connexion et d’un chemin d’entité spécifiés.

Propriétés

ClientId	Obtient l’ID permettant d’identifier ce client. Cela peut être utilisé pour mettre en corrélation les journaux et les exceptions. (Hérité de ClientEntity)
IsClosedOrClosing	Retourne true si le client est fermé ou fermé. (Hérité de ClientEntity)
LastPeekedSequenceNumber	Obtient le numéro de séquence du dernier message aperçu.
OperationTimeout	Durée après laquelle les opérations individuelles expirent.
OwnsConnection	Retourne true si la connexion est détenue et false si la connexion est partagée. (Hérité de ClientEntity)
Path	Chemin d’accès de l’entité pour ce récepteur. Pour les files d’attente, il s’agit du nom, mais pour les abonnements, il s’agit du chemin d’accès.
PrefetchCount	La prérécupération accélère le flux de message en visant à avoir un message facilement disponible pour une récupération locale lorsque et avant que l’application en demande un à l’aide de Receive. La définition d’une valeur différente de zéro préréfète le nombre de messages PrefetchCount. La définition de la valeur zéro désactive la prérécupération. La valeur par défaut est 0.
ReceiveMode	Obtient le ReceiveMode du récepteur actuel.
RegisteredPlugins	Obtient la liste des plug-ins actuellement inscrits.
RetryPolicy	Obtient le RetryPolicy défini sur le client. (Hérité de ClientEntity)
ServiceBusConnection	Objet de connexion à l’espace de noms Service Bus.

Méthodes

AbandonAsync(String, IDictionary<String,Object>)	Abandonne un à l’aide Message d’un jeton de verrou. Le message sera de nouveau disponible pour traitement.
CloseAsync()	Ferme le client. Ferme les connexions ouvertes par celui-ci. (Hérité de ClientEntity)
CompleteAsync(IEnumerable<String>)	Termine une série d’utilisation d’une Message liste de jetons de verrou. Cela supprime le message du service.
CompleteAsync(String)	Termine un à l’aide de Message son jeton de verrou. Cela supprime le message du service.
DeadLetterAsync(String, IDictionary<String,Object>)	Déplace un message vers la sous-file d’attente deadletter.
DeadLetterAsync(String, String, String)	Déplace un message vers la sous-file d’attente deadletter.
DeferAsync(String, IDictionary<String,Object>)	Indique que le récepteur souhaite différer le traitement du message.
OnAbandonAsync(String, IDictionary<String,Object>)	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnClosingAsync()	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnCompleteAsync(IEnumerable<String>)	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnDeadLetterAsync(String, IDictionary<String,Object>, String, String)	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnDeferAsync(String, IDictionary<String,Object>)	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnMessageHandler(MessageHandlerOptions, Func<Message,CancellationToken,Task>)	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnPeekAsync(Int64, Int32)	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnReceiveAsync(Int32, TimeSpan)	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnReceiveDeferredMessageAsync(Int64[])	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
OnRenewLockAsync(String)	MessageReceiver peut être utilisé pour recevoir des messages de files d’attente et d’abonnements et les accuser réception.
PeekAsync()	Récupère le message actif suivant sans modifier l’état du récepteur ou de la source du message.
PeekAsync(Int32)	Récupère le lot suivant de messages actifs sans modifier l’état du récepteur ou de la source du message.
PeekBySequenceNumberAsync(Int64)	Lit de façon asynchrone le message suivant sans modifier l’état du récepteur ou de la source du message.
PeekBySequenceNumberAsync(Int64, Int32)	Affiche un lot de messages.
ReceiveAsync()	Recevez un message de l’entité définie à Path l’aide du ReceiveMode mode .
ReceiveAsync(Int32)	Reçoit un maximum de messages de l’entité maxMessageCount définie à Path l’aide ReceiveMode du mode .
ReceiveAsync(Int32, TimeSpan)	Reçoit un maximum de messages de l’entité maxMessageCount définie à Path l’aide ReceiveMode du mode .
ReceiveAsync(TimeSpan)	Recevez un message de l’entité définie à Path l’aide du ReceiveMode mode .
ReceiveDeferredMessageAsync(IEnumerable<Int64>)	Reçoit un IList<T> de messages différés identifiés par sequenceNumbers.
ReceiveDeferredMessageAsync(Int64)	Reçoit un message différé spécifique identifié par sequenceNumber.
RegisterMessageHandler(Func<Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)	Recevoir des messages en continu de l’entité. Inscrit un gestionnaire de messages et commence un nouveau thread pour recevoir des messages. Ce gestionnaire(Func<T1,T2,TResult>) est attendu chaque fois qu’un nouveau message est reçu par le destinataire.
RegisterMessageHandler(Func<Message,CancellationToken,Task>, MessageHandlerOptions)	Recevoir des messages en continu de l’entité. Inscrit un gestionnaire de messages et commence un nouveau thread pour recevoir des messages. Ce gestionnaire(Func<T1,T2,TResult>) est attendu chaque fois qu’un nouveau message est reçu par le destinataire.
RegisterPlugin(ServiceBusPlugin)	Inscrit un ServiceBusPlugin à utiliser avec ce récepteur.
RenewLockAsync(Message)	Renouvelle le verrou sur le message spécifié par le jeton de verrou. Le verrou est renouvelé en fonction du paramètre spécifié dans la file d’attente.
RenewLockAsync(String)	Renouvelle le verrou sur le message. Le verrou est renouvelé en fonction du paramètre spécifié dans la file d’attente. Date et heure d’expiration du nouveau jeton de verrouillage au format UTC.
ThrowIfClosed()	Lève une exception OperationCanceledException si l’objet est Closing. (Hérité de ClientEntity)
UnregisterMessageHandlerAsync(TimeSpan)	Désinscrire le gestionnaire de messages du récepteur s’il existe un gestionnaire de messages actif inscrit. Cette opération attend que la fin des opérations de réception en vol et de gestion des messages se termine, et annule l’inscription des réceptions futures sur le gestionnaire de messages précédemment inscrit.
UnregisterPlugin(String)	Annule l’inscription d’un ServiceBusPlugin.