IQueueClient Interface

Référence

Définition

Espace de noms:: Microsoft.Azure.ServiceBus

Assembly:: Microsoft.Azure.ServiceBus.dll

Paquet:: Microsoft.Azure.ServiceBus v5.2.0

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 interface IQueueClient : Microsoft.Azure.ServiceBus.Core.IReceiverClient, Microsoft.Azure.ServiceBus.Core.ISenderClient

type IQueueClient = interface
    interface IReceiverClient
    interface IClientEntity
    interface ISenderClient

Public Interface IQueueClient
Implements IReceiverClient, ISenderClient

Dérivé: Microsoft.Azure.ServiceBus.QueueClient

Implémente: IReceiverClient ISenderClient IClientEntity

Exemples

Créer une file d’attente QueueClient

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 IMessageSender ou IMessageReceiver pour un ensemble avancé de fonctionnalité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 IClientEntity)
IsClosedOrClosing	Retourne true si le client est fermé ou fermé. (Hérité de IClientEntity)
OperationTimeout	Durée après laquelle les opérations individuelles expirent. (Hérité de IClientEntity)
OwnsConnection	Retourne true si la connexion est détenue et false si la connexion est partagée. (Hérité de IClientEntity)
Path	Obtient le chemin d’accès de l’entité. (Hérité de IClientEntity)
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. (Hérité de IReceiverClient)
QueueName	Obtient le nom de la file d'attente.
ReceiveMode	Obtient le ReceiveMode du récepteur actuel. (Hérité de IReceiverClient)
RegisteredPlugins	Obtient la liste des plug-ins actuellement inscrits pour ce client. (Hérité de IClientEntity)
ServiceBusConnection	Objet de connexion à l’espace de noms Service Bus. (Hérité de IClientEntity)

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. (Hérité de IReceiverClient)
CancelScheduledMessageAsync(Int64)	Annule un message qui a été planifié. (Hérité de ISenderClient)
CloseAsync()	Ferme le client. Ferme les connexions ouvertes par celui-ci. (Hérité de IClientEntity)
CompleteAsync(String)	Termine un à l’aide de Message son jeton de verrou. Cela supprime le message de la file d’attente. (Hérité de IReceiverClient)
DeadLetterAsync(String, IDictionary<String,Object>)	Déplace un message vers la sous-file d’attente deadletter. (Hérité de IReceiverClient)
DeadLetterAsync(String, String, String)	Déplace un message vers la sous-file d’attente deadletter. (Hérité de IReceiverClient)
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. (Hérité de IReceiverClient)
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. (Hérité de IReceiverClient)
RegisterPlugin(ServiceBusPlugin)	Inscrit un ServiceBusPlugin à utiliser avec ce client. (Hérité de IClientEntity)
RegisterSessionHandler(Func<IMessageSession,Message,CancellationToken,Task>, Func<ExceptionReceivedEventArgs,Task>)	Recevoir 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)	Recevoir 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 d’un message dans Service Bus. (Hérité de ISenderClient)
SendAsync(IList<Message>)	Envoie une liste de messages à Service Bus. Lorsqu’ils sont appelés sur des entités partitionnée, les messages destinés à différentes partitions ne peuvent pas être regroupés. (Hérité de ISenderClient)
SendAsync(Message)	Envoie un message à Service Bus. (Hérité de ISenderClient)
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. (Hérité de IReceiverClient)
UnregisterPlugin(String)	Annule l’inscription d’un ServiceBusPlugin. (Hérité de IClientEntity)
UnregisterSessionHandlerAsync(TimeSpan)	Désinscrire le gestionnaire de session du récepteur s’il existe un gestionnaire de session actif inscrit. Cette opération attend la fin des opérations de réception en vol et de gestion de session, et annule l’inscription des réceptions futures sur le gestionnaire de session précédemment inscrit.

S’applique à

Voir aussi

QueueClient

Partager via