SessionClient クラス

リファレンス

定義

名前空間:: Microsoft.Azure.ServiceBus

アセンブリ:: Microsoft.Azure.ServiceBus.dll

パッケージ:: Microsoft.Azure.ServiceBus v5.2.0

ソース:: SessionClient.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

セッションクライアントを使用すると、セッションオブジェクトを受け入れることができ、同じ 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

継承: Object

ClientEntity
SessionClient

実装: IClientEntity ISessionClient

例

新しい SessionClient を作成するには

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

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

IMessageSession session = await sessionClient.AcceptMessageSessionAsync(sessionId);

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

IMessageSession session = await sessionClient.AcceptMessageSessionAsync();

注釈

任意のセッションまたは特定のセッション (セッションクライアントを使用して SessionId 識別) を受け入れることが可能です。セッションを受け入れると、同じセッション ID を持つメッセージのみを受信するとして MessageReceiver 使用できます。セッションオブジェクトの使用方法については、「」を参照してください IMessageSession 。これにより、AMQP プロトコルを使用してサービスと通信します。

コンストラクター

SessionClient(ServiceBusConnection, String, ReceiveMode, RetryPolicy, Int32)	指定されたに新しい SessionClient を作成します。 ServiceBusConnection
SessionClient(ServiceBusConnectionStringBuilder, ReceiveMode, RetryPolicy, Int32)	から新しい SessionClient を作成します。 ServiceBusConnectionStringBuilder
SessionClient(String, String, ITokenProvider, TransportType, ReceiveMode, RetryPolicy, Int32)	指定したエンドポイント、エンティティパス、トークンプロバイダーから新しい SessionClient を作成します。
SessionClient(String, String, ReceiveMode, RetryPolicy, Int32)	指定した接続文字列とエンティティパスから新しい SessionClient を作成します。

プロパティ

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

メソッド

AcceptMessageSessionAsync()	その sessionId のメッセージを受信するために使用できるの SessionId セッションオブジェクトを取得します。
AcceptMessageSessionAsync(String)	その sessionId のメッセージを受信するために使用できるによって `sessionId` 識別される特定のセッションオブジェクトを取得します。
AcceptMessageSessionAsync(String, TimeSpan)	その sessionId のメッセージを受信するために使用できるによって `sessionId` 識別される特定のセッションオブジェクトを取得します。
AcceptMessageSessionAsync(TimeSpan)	その sessionId のメッセージを受信するために使用できるの SessionId セッションオブジェクトを取得します。
CloseAsync()	クライアントを閉じます。その接続によって開かれた接続を閉じます。 (継承元 ClientEntity)
OnClosingAsync()	セッションクライアントを使用すると、セッションオブジェクトを受け入れることができ、同じ sessionId を持つすべてのメッセージを操作するために使用できます。 (継承元 ClientEntity)
RegisterPlugin(ServiceBusPlugin)	ServiceBusPluginこのレシーバーで使用するを登録します。
ThrowIfClosed()	オブジェクトが Closing の場合は、OperationCanceledException をスローします。 (継承元 ClientEntity)
UnregisterPlugin(String)	の登録を ServiceBusPlugin解除します。

適用対象

こちらもご覧ください

IMessageSession

Share via