ISessionClient インターフェイス

定義

名前空間:

Microsoft.Azure.ServiceBus

アセンブリ:

Microsoft.Azure.ServiceBus.dll

パッケージ:

Microsoft.Azure.ServiceBus v5.2.0

セッション クライアントについて説明します。 セッション クライアントを使用すると、セッション オブジェクトを受け入れることができ、同じ sessionId を持つすべてのメッセージを操作するために使用できます。

public interface ISessionClient : Microsoft.Azure.ServiceBus.IClientEntity

type ISessionClient = interface
    interface IClientEntity

Public Interface ISessionClient
Implements IClientEntity

派生

Microsoft.Azure.ServiceBus.SessionClient

実装

IClientEntity

注釈

任意のセッションまたは特定のセッション (セッション クライアントを使用して SessionId 識別) を受け入れます。 セッションを受け入れると、同じセッション ID を持つメッセージのみを受信する として MessageReceiver 使用できます。セッション オブジェクトの使用方法については、 を参照してください IMessageSession 。

新しい SessionClient を作成するには

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

特定の sessionId のセッション オブジェクトを受信するには

IMessageSession session = await sessionClient.AcceptMessageSessionAsync(sessionId);

任意のセッションを受信するには

IMessageSession session = await sessionClient.AcceptMessageSessionAsync();

プロパティ

ClientId	このクライアントを識別する ID を取得します。 これは、ログと例外を関連付けるために使用できます。 (継承元 IClientEntity)
EntityPath	エンティティのパスを取得します。 これは、キューの名前、またはサブスクリプションの完全なパスです。
IsClosedOrClosing	クライアントが閉じているか閉じている場合は true を返します。 (継承元 IClientEntity)
OperationTimeout	個々の操作がタイムアウトするまでの期間。 (継承元 IClientEntity)
OwnsConnection	接続が所有されている場合は true、接続が共有されている場合は false を返します。 (継承元 IClientEntity)
Path	エンティティ パスを取得します。 (継承元 IClientEntity)
RegisteredPlugins	このクライアントの現在登録されているプラグインの一覧を取得します。 (継承元 IClientEntity)
ServiceBusConnection	Service Bus 名前空間への接続オブジェクト。 (継承元 IClientEntity)

メソッド

AcceptMessageSessionAsync()	その sessionId のメッセージを受信するために使用できる 任意 SessionId の のセッション オブジェクトを取得します。
AcceptMessageSessionAsync(String)	その sessionId のメッセージを受信するために使用できる、 によって sessionId 識別される特定のセッション オブジェクトを取得します。
AcceptMessageSessionAsync(String, TimeSpan)	その sessionId のメッセージを受信するために使用できる、 によって sessionId 識別される特定のセッション オブジェクトを取得します。
AcceptMessageSessionAsync(TimeSpan)	その sessionId のメッセージを受信するために使用できる 任意 SessionId の のセッション オブジェクトを取得します。
CloseAsync()	クライアントを閉じます。 によって開かれた接続を閉じます。 (継承元 IClientEntity)
RegisterPlugin(ServiceBusPlugin)	ServiceBusPluginこのクライアントで使用する を登録します。 (継承元 IClientEntity)
UnregisterPlugin(String)	の登録を解除します ServiceBusPlugin。 (継承元 IClientEntity)

こちらもご覧ください

• IMessageSession
• SessionClient