QueueClient Classe

Référence

Définition

Espace de noms:: Microsoft.Azure.ServiceBus

Assembly:: Microsoft.Azure.ServiceBus.dll

Paquet:: Microsoft.Azure.ServiceBus v5.2.0

Source:: QueueClient.cs

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

QueueClient peut être utilisé pour toutes les interactions de base avec une file d’attente Service Bus.

public class QueueClient : Microsoft.Azure.ServiceBus.ClientEntity, Microsoft.Azure.ServiceBus.IQueueClient

type QueueClient = class
    inherit ClientEntity
    interface IQueueClient
    interface IReceiverClient
    interface IClientEntity
    interface ISenderClient

Public Class QueueClient
Inherits ClientEntity
Implements IQueueClient

Héritage: Object

ClientEntity
QueueClient

Implémente: IReceiverClient ISenderClient IClientEntity IQueueClient

Exemples

Créer une file d’attenteClient

IQueueClient queueClient = new QueueClient(
    namespaceConnectionString,
    queueName,
    ReceiveMode.PeekLock,
    RetryExponential);

Envoyez un message à la file d’attente :

byte[] data = GetData();
await queueClient.SendAsync(data);

Inscrivez un gestionnaire de messages qui sera appelé chaque fois qu’un message est reçu.

queueClient.RegisterMessageHandler(
       async (message, token) =>
       {
           // Process the message
           Console.WriteLine($"Received message: SequenceNumber:{message.SystemProperties.SequenceNumber} Body:{Encoding.UTF8.GetString(message.Body)}");

           // Complete the message so that it is not received again.
           // This can be done only if the queueClient is opened in ReceiveMode.PeekLock mode.
           await queueClient.CompleteAsync(message.SystemProperties.LockToken);
       },
       async (exceptionEvent) =>
       {
           // Process the exception
           Console.WriteLine("Exception = " + exceptionEvent.Exception);
           return Task.CompletedTask;
       });

Remarques

Utilisez MessageSender ou MessageReceiver pour un ensemble avancé de fonctionnalités. Il utilise le protocole AMQP pour communiquer avec servicebus.

Constructeurs

QueueClient(ServiceBusConnection, String, ReceiveMode, RetryPolicy)	Crée un instance du client file d’attente sur un objet donnéServiceBusConnection
QueueClient(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy)	Instancie un nouveau QueueClient pour effectuer des opérations sur une file d’attente.
QueueClient(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy)	Crée une instance du client file d’attente à l’aide du point de terminaison, du chemin d’accès d’entité et du fournisseur de jeton spécifiés.
QueueClient(String, String, ReceiveMode, RetryPolicy)	Instancie un nouveau QueueClient pour effectuer des opérations sur une file d’attente.

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)
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	Obtient le nom de la file d'attente.
PrefetchCount	La préversion accélère le flux de message en visant à avoir un message facilement disponible pour la récupération locale lorsque et avant que l’application en demande un à l’aide de La réception. La définition d’une valeur autre que zéro préfète le nombre de messages PrefetchCount. La définition de la valeur sur zéro désactive la prérécupération. La valeur par défaut est 0.
QueueName	Obtient le nom de la file d'attente.
ReceiveMode	Obtient le ReceiveMode pour queueClient.
RegisteredPlugins	Obtient la liste des plug-ins actuellement inscrits pour ce QueueClient.
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 d’un Message jeton de verrou. Cela rend le message à nouveau disponible pour traitement.
CancelScheduledMessageAsync(Int64)	Annule un message qui a été planifié.
CloseAsync()	Ferme le client. Ferme les connexions ouvertes par celui-ci. (Hérité de ClientEntity)
CompleteAsync(String)	Effectue une opération à l’aide Message de son jeton de verrouillage. Cela supprime le message de la file d’attente.
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.
OnClosingAsync()	QueueClient peut être utilisé pour toutes les interactions de base avec une file d’attente Service Bus.
RegisterMessageHandler(Func<Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)	Recevez des messages en continu à partir 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)	Recevez des messages en continu à partir 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 client de file d’attente.
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)	Recevez des messages de session en continu à partir de la file d’attente. Inscrit un gestionnaire de messages et commence un nouveau thread pour recevoir des messages de session. Ce gestionnaire(Func<T1,T2,T3,TResult>) est attendu chaque fois qu’un nouveau message est reçu par le client de file d’attente.
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, SessionHandlerOptions)	Recevez des messages de session en continu à partir de la file d’attente. Inscrit un gestionnaire de messages et commence un nouveau thread pour recevoir des messages de session. Ce gestionnaire(Func<T1,T2,T3,TResult>) est attendu chaque fois qu’un nouveau message est reçu par le client de file d’attente.
ScheduleMessageAsync(Message, DateTimeOffset)	Planifie l’affichage ultérieur d’un message dans Service Bus.
SendAsync(IList<Message>)	Envoie une liste de messages à Service Bus. Lorsqu’ils sont appelés sur des entités partitionnées, les messages destinés à différentes partitions ne peuvent pas être traités par lot.
SendAsync(Message)	Envoie un message à Service Bus.
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 la fin des opérations de réception en vol et de gestion des messages pour se terminer et annule l’inscription des futures réceptions sur le gestionnaire de messages précédemment inscrit.
UnregisterPlugin(String)	Annule l’inscription d’un ServiceBusPlugin.
UnregisterSessionHandlerAsync(TimeSpan)	Désinscrire le gestionnaire de session du récepteur s’il existe un gestionnaire de session actif inscrit. Cette opération attend que la fin des opérations de réception et de gestion de session en vol se termine et annule l’inscription des futures réceptions sur le gestionnaire de session précédemment inscrit.

S’applique à