IMessageSession Interface

Définition

Espace de noms:

Microsoft.Azure.ServiceBus

Assembly:

Microsoft.Azure.ServiceBus.dll

Paquet:

Microsoft.Azure.ServiceBus v5.2.0

Décrit un objet Session. IMessageSession peut être utilisé pour effectuer des opérations sur les sessions.

public interface IMessageSession : Microsoft.Azure.ServiceBus.Core.IMessageReceiver

type IMessageSession = interface
    interface IMessageReceiver
    interface IReceiverClient
    interface IClientEntity

Public Interface IMessageSession
Implements IMessageReceiver

Implémente

IMessageReceiver IReceiverClient IClientEntity

Remarques

Les sessions Service Bus, également appelées « groupes » dans le protocole AMQP 1.0, sont des séquences sans limite de messages associés. ServiceBus garantit l’ordre des messages dans une session.

Tout expéditeur peut créer une session lors de l’envoi de messages dans une rubrique ou une file d’attente en définissant la SessionId propriété sur Message sur un identificateur unique défini par l’application. Au niveau du protocole AMQP 1.0, cette valeur est mappée sur la propriété group-id.

Les sessions entrent en vigueur lorsqu’il existe au moins un message avec le SessionId de la session dans l’abonnement File d’attente ou Rubrique. Une fois qu’une session existe, il n’existe aucun moment ou mouvement défini pour le moment où la session expire ou disparaît.

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)
LastPeekedSequenceNumber	Obtient le numéro de séquence du dernier message aperçu. (Hérité de IMessageReceiver)
LockedUntilUtc	Obtient l’heure pendant laquelle la session identifiée par SessionId est verrouillée jusqu’à ce que pour ce client.
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é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. (Hérité de IReceiverClient)
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)
SessionId	Obtient le SessionId.

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. (Hérité de IReceiverClient)
CloseAsync()	Ferme le client. Ferme les connexions ouvertes par celui-ci. (Hérité de IClientEntity)
CompleteAsync(IEnumerable<String>)	Termine une série d’utilisation d’une Message liste de jetons de verrouillage. Cela supprime le message du service. (Hérité de IMessageReceiver)
CompleteAsync(String)	Effectue une opération à l’aide Message de son jeton de verrouillage. 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)
DeferAsync(String, IDictionary<String,Object>)	Indique que le destinataire souhaite différer le traitement du message. (Hérité de IMessageReceiver)
GetStateAsync()	Obtient l’état de session.
PeekAsync()	Extrait le message actif suivant sans modifier l’état du récepteur ou de la source du message. (Hérité de IMessageReceiver)
PeekAsync(Int32)	Extrait le lot suivant de messages actifs sans modifier l’état du récepteur ou de la source du message. (Hérité de IMessageReceiver)
PeekBySequenceNumberAsync(Int64)	Lit de manière asynchrone le message suivant sans modifier l’état du récepteur ou de la source du message. (Hérité de IMessageReceiver)
PeekBySequenceNumberAsync(Int64, Int32)	Effectue un aperçu d’un lot de messages. (Hérité de IMessageReceiver)
ReceiveAsync()	Recevez un message de l’entité définie à l’aide du PathReceiveMode mode . (Hérité de IMessageReceiver)
ReceiveAsync(Int32)	Reçoit un maximum de messages de l’entité maxMessageCount définie à l’aide du PathReceiveMode mode . (Hérité de IMessageReceiver)
ReceiveAsync(Int32, TimeSpan)	Reçoit un maximum de messages de l’entité maxMessageCount définie à l’aide du PathReceiveMode mode . (Hérité de IMessageReceiver)
ReceiveAsync(TimeSpan)	Recevez un message de l’entité définie à l’aide du PathReceiveMode mode . (Hérité de IMessageReceiver)
ReceiveDeferredMessageAsync(IEnumerable<Int64>)	Reçoit un IList<T> de messages différés identifiés par sequenceNumbers. (Hérité de IMessageReceiver)
ReceiveDeferredMessageAsync(Int64)	Reçoit un message différé spécifique identifié par sequenceNumber. (Hérité de IMessageReceiver)
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. (Hérité de IReceiverClient)
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. (Hérité de IReceiverClient)
RegisterPlugin(ServiceBusPlugin)	Inscrit un ServiceBusPlugin à utiliser avec ce client. (Hérité de IClientEntity)
RenewLockAsync(Message)	Renouvelle le verrou sur le message. Le verrou sera renouvelé en fonction du paramètre spécifié dans la file d’attente. (Hérité de IMessageReceiver)
RenewLockAsync(String)	Renouvelle le verrou sur le message. Le verrou sera 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. (Hérité de IMessageReceiver)
RenewSessionLockAsync()	Renouvelle le verrou sur la session spécifiée par .SessionId Le verrou est renouvelé en fonction du paramètre spécifié sur l’entité.
SetStateAsync(Byte[])	Définir un état personnalisé sur la session qui peut être récupéré ultérieurement à l’aide de GetStateAsync()
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. (Hérité de IReceiverClient)
UnregisterPlugin(String)	Annule l’inscription d’un ServiceBusPlugin. (Hérité de IClientEntity)