SessionClient 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:: SessionClient.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.

Un client de session peut être utilisé pour accepter des objets de session qui peuvent être utilisés pour interagir avec tous les messages avec le même sessionId.

public sealed class SessionClient : Microsoft.Azure.ServiceBus.ClientEntity, Microsoft.Azure.ServiceBus.ISessionClient

type SessionClient = class
    inherit ClientEntity
    interface ISessionClient
    interface IClientEntity

Public NotInheritable Class SessionClient
Inherits ClientEntity
Implements ISessionClient

Héritage: Object

ClientEntity
SessionClient

Implémente: IClientEntity ISessionClient

Exemples

Pour créer un sessionClient

ISessionClient sessionClient = new SessionClient(
    namespaceConnectionString,
    queueName,
    ReceiveMode.PeekLock);

Pour recevoir un objet de session pour un sessionId donné

IMessageSession session = await sessionClient.AcceptMessageSessionAsync(sessionId);

Pour recevoir une session

IMessageSession session = await sessionClient.AcceptMessageSessionAsync();

Remarques

Vous pouvez accepter n’importe quelle session ou une session donnée (identifiée à l’aide SessionId d’un client de session. Une fois que vous avez accepté une session, vous pouvez l’utiliser comme un MessageReceiver qui reçoit uniquement les messages ayant le même ID de session. Consultez IMessageSession pour l’utilisation de l’objet de session. Cela utilise le protocole AMQP pour communiquer avec le service.

Constructeurs

SessionClient(ServiceBusConnection, String, ReceiveMode, RetryPolicy, Int32)	Crée un sessionClient sur un donné ServiceBusConnection
SessionClient(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy, Int32)	Crée un sessionClient à partir d’un ServiceBusConnectionStringBuilder
SessionClient(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy, Int32)	Crée un sessionClient à partir d’un point de terminaison, d’un chemin d’entité et d’un fournisseur de jetons spécifiés.
SessionClient(String, String, ReceiveMode, RetryPolicy, Int32)	Crée un sessionClient à 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)
EntityPath	Obtient le chemin de l’entité. Il s’agit du nom de la file d’attente ou du chemin d’accès complet de l’abonnement.
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 chemin de l’entité. Il s’agit du nom de la file d’attente ou du chemin d’accès complet de l’abonnement.
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

AcceptMessageSessionAsync()	Obtient un objet de session de n’importe quel SessionId objet qui peut être utilisé pour recevoir des messages pour ce sessionId.
AcceptMessageSessionAsync(String)	Obtient un objet de session particulier identifié par `sessionId` qui peut être utilisé pour recevoir des messages pour ce sessionId.
AcceptMessageSessionAsync(String, TimeSpan)	Obtient un objet de session particulier identifié par `sessionId` qui peut être utilisé pour recevoir des messages pour ce sessionId.
AcceptMessageSessionAsync(TimeSpan)	Obtient un objet de session de n’importe quel SessionId objet qui peut être utilisé pour recevoir des messages pour ce sessionId.
CloseAsync()	Ferme le client. Ferme les connexions ouvertes par celui-ci. (Hérité de ClientEntity)
OnClosingAsync()	Un client de session peut être utilisé pour accepter des objets de session qui peuvent être utilisés pour interagir avec tous les messages avec le même sessionId. (Hérité de ClientEntity)
RegisterPlugin(ServiceBusPlugin)	Inscrit un ServiceBusPlugin à utiliser avec ce récepteur.
ThrowIfClosed()	Lève une exception OperationCanceledException si l’objet est Closing. (Hérité de ClientEntity)
UnregisterPlugin(String)	Annule l’inscription d’un ServiceBusPlugin.

S’applique à

Voir aussi

IMessageSession

Partager via