SessionClient Klasse

Referenz

Definition

Namespace:: Microsoft.Azure.ServiceBus

Assembly:: Microsoft.Azure.ServiceBus.dll

Paket:: Microsoft.Azure.ServiceBus v5.2.0

Quelle:: SessionClient.cs

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ein Sitzungsclient kann verwendet werden, um Sitzungsobjekte zu akzeptieren, die für die Interaktion mit allen Nachrichten mit derselben sessionId verwendet werden können.

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

Vererbung: Object

ClientEntity
SessionClient

Implementiert: IClientEntity ISessionClient

Beispiele

So erstellen Sie einen neuen SessionClient

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

So empfangen Sie ein Sitzungsobjekt für eine bestimmte sessionId

IMessageSession session = await sessionClient.AcceptMessageSessionAsync(sessionId);

So empfangen Sie eine beliebige Sitzung

IMessageSession session = await sessionClient.AcceptMessageSessionAsync();

Hinweise

Sie können jede Sitzung oder eine bestimmte Sitzung (identifiziert durch SessionId einen Sitzungsclient) akzeptieren. Nachdem Sie eine Sitzung akzeptiert haben, können Sie sie als eine MessageReceiver verwenden, die nur Nachrichten mit derselben Sitzungs-ID empfängt. Informationen zur Verwendung des Sitzungsobjekts finden Sie unter IMessageSession . Dabei wird das AMQP-Protokoll für die Kommunikation mit dem Dienst verwendet.

Konstruktoren

SessionClient(ServiceBusConnection, String, ReceiveMode, RetryPolicy, Int32)	Erstellt einen neuen SessionClient für eine bestimmte ServiceBusConnection
SessionClient(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy, Int32)	Erstellt einen neuen SessionClient aus einem ServiceBusConnectionStringBuilder
SessionClient(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy, Int32)	Erstellt einen neuen SessionClient aus einem angegebenen Endpunkt, Entitätspfad und Tokenanbieter.
SessionClient(String, String, ReceiveMode, RetryPolicy, Int32)	Erstellt einen neuen SessionClient aus einer angegebenen Verbindungszeichenfolge und einem angegebenen Entitätspfad.

Eigenschaften

ClientId	Ruft die ID ab, um diesen Client zu identifizieren. Dies kann verwendet werden, um Protokolle und Ausnahmen zu korrelieren. (Geerbt von ClientEntity)
EntityPath	Ruft den Pfad der Entität ab. Dies ist entweder der Name der Warteschlange oder der vollständige Pfad des Abonnements.
IsClosedOrClosing	Gibt true zurück, wenn der Client geschlossen oder geschlossen ist. (Geerbt von ClientEntity)
OperationTimeout	Dauer, nach der für einzelne Vorgänge ein Timeout auftritt.
OwnsConnection	Gibt true zurück, wenn die Verbindung im Besitz ist, und false, wenn die Verbindung freigegeben wird. (Geerbt von ClientEntity)
Path	Ruft den Pfad der Entität ab. Dies ist entweder der Name der Warteschlange oder der vollständige Pfad des Abonnements.
RegisteredPlugins	Ruft eine Liste der aktuell registrierten Plug-Ins ab.
RetryPolicy	Ruft die RetryPolicy auf dem Client definierte ab. (Geerbt von ClientEntity)
ServiceBusConnection	Verbindungsobjekt mit dem Service Bus-Namespace.

Methoden

AcceptMessageSessionAsync()	Ruft ein Sitzungsobjekt eines beliebigen SessionId Objekts ab, das zum Empfangen von Nachrichten für diese sessionId verwendet werden kann.
AcceptMessageSessionAsync(String)	Ruft ein bestimmtes Sitzungsobjekt ab, das durch identifiziert wird, das zum Empfangen von `sessionId` Nachrichten für diese sessionId verwendet werden kann.
AcceptMessageSessionAsync(String, TimeSpan)	Ruft ein bestimmtes Sitzungsobjekt ab, das durch identifiziert wird, das zum Empfangen von `sessionId` Nachrichten für diese sessionId verwendet werden kann.
AcceptMessageSessionAsync(TimeSpan)	Ruft ein Sitzungsobjekt eines beliebigen SessionId Objekts ab, das zum Empfangen von Nachrichten für diese sessionId verwendet werden kann.
CloseAsync()	Schließt den Client. Schließt die von ihr geöffneten Verbindungen. (Geerbt von ClientEntity)
OnClosingAsync()	Ein Sitzungsclient kann verwendet werden, um Sitzungsobjekte zu akzeptieren, die für die Interaktion mit allen Nachrichten mit derselben sessionId verwendet werden können. (Geerbt von ClientEntity)
RegisterPlugin(ServiceBusPlugin)	Registriert eine ServiceBusPlugin , die mit diesem Empfänger verwendet werden soll.
ThrowIfClosed()	Lösen Sie eine OperationCanceledException aus, wenn das Objekt Geschlossen ist. (Geerbt von ClientEntity)
UnregisterPlugin(String)	Hebt die Registrierung eines auf ServiceBusPlugin.

Gilt für:

Weitere Informationen

IMessageSession