ServiceBusClient.AcceptSessionAsync メソッド

定義

名前空間:

Azure.Messaging.ServiceBus

アセンブリ:

Azure.Messaging.ServiceBus.dll

パッケージ:

Azure.Messaging.ServiceBus v7.17.5

オーバーロード

AcceptSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)	特定のセッションを ServiceBusSessionReceiver 受け入れることで、セッションが有効なキューからのメッセージの受信と解決に使用できるインスタンスを作成します。 メッセージの ServiceBusReceiveMode 受信方法を ServiceBusReceiverOptions 構成するには、 で を指定できます。 既定値は PeekLock です。
AcceptSessionAsync(String, String, String, ServiceBusSessionReceiverOptions, CancellationToken)	特定のセッションを ServiceBusSessionReceiver 受け入れることで、セッションが有効なサブスクリプションからのメッセージの受信と決済に使用できるインスタンスを作成します。 メッセージの ServiceBusReceiveMode 受信方法を ServiceBusReceiverOptions 構成するには、 で を指定できます。 既定値は PeekLock です。

AcceptSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)

Source:

ServiceBusClient.cs

特定のセッションを ServiceBusSessionReceiver 受け入れることで、セッションが有効なキューからのメッセージの受信と解決に使用できるインスタンスを作成します。 メッセージの ServiceBusReceiveMode 受信方法を ServiceBusReceiverOptions 構成するには、 で を指定できます。 既定値は PeekLock です。

public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver> AcceptSessionAsync (string queueName, string sessionId, Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member AcceptSessionAsync : string * string * Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver>
override this.AcceptSessionAsync : string * string * Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver>

Public Overridable Function AcceptSessionAsync (queueName As String, sessionId As String, Optional options As ServiceBusSessionReceiverOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusSessionReceiver)

パラメーター

queueName

String

を作成するセッションが有効な ServiceBusSessionReceiver キュー。

sessionId

String

のスコープ ServiceBusSessionReceiver を設定するセッション ID を取得または設定します。

options

ServiceBusSessionReceiverOptions

を構成するために使用する のServiceBusSessionReceiverセットServiceBusSessionReceiverOptions。

cancellationToken

CancellationToken

操作を取り消す要求を通知する省略可能 CancellationToken なインスタンス。

戻り値

Task<ServiceBusSessionReceiver>

ServiceBusSessionReceiver指定したキューと特定のセッションをスコープとする 。

例外

ServiceBusException

は sessionId 、別のレシーバーによって現在ロックされているセッションに対応します。 Reasonこの場合、 は にSessionCannotBeLocked設定されます。

注釈

これによりセッション ロックが確立されるため、このメソッドはサービス呼び出しを実行します。 sessionId パラメーターが null で、キューに使用可能なメッセージがない場合は、 の ServiceTimeoutがReasonスローServiceBusExceptionされます。

AcceptSessionAsync(String, String, String, ServiceBusSessionReceiverOptions, CancellationToken)

Source:

ServiceBusClient.cs

特定のセッションを ServiceBusSessionReceiver 受け入れることで、セッションが有効なサブスクリプションからのメッセージの受信と決済に使用できるインスタンスを作成します。 メッセージの ServiceBusReceiveMode 受信方法を ServiceBusReceiverOptions 構成するには、 で を指定できます。 既定値は PeekLock です。

public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver> AcceptSessionAsync (string topicName, string subscriptionName, string sessionId, Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member AcceptSessionAsync : string * string * string * Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver>
override this.AcceptSessionAsync : string * string * string * Azure.Messaging.ServiceBus.ServiceBusSessionReceiverOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusSessionReceiver>

Public Overridable Function AcceptSessionAsync (topicName As String, subscriptionName As String, sessionId As String, Optional options As ServiceBusSessionReceiverOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusSessionReceiver)

パラメーター

topicName

String

を作成 ServiceBusSessionReceiver するトピック。

subscriptionName

String

を作成するセッションが有効な ServiceBusSessionReceiver サブスクリプション。

sessionId

String

のスコープ ServiceBusSessionReceiver を設定するセッション ID を取得または設定します。

options

ServiceBusSessionReceiverOptions

を構成するために使用する のServiceBusSessionReceiverセットServiceBusSessionReceiverOptions。

cancellationToken

CancellationToken

操作を取り消す要求を通知する省略可能 CancellationToken なインスタンス。

戻り値

Task<ServiceBusSessionReceiver>

ServiceBusSessionReceiver指定したキューと特定のセッションをスコープとする 。

例外

ServiceBusException

は sessionId 、別のレシーバーによって現在ロックされているセッションに対応します。 Reasonこの場合、 は にSessionCannotBeLocked設定されます。

注釈

これによりセッション ロックが確立されるため、このメソッドはサービス呼び出しを実行します。 sessionId パラメーターが null で、キューに使用可能なメッセージがない場合は、 の ServiceTimeoutがReasonスローServiceBusExceptionされます。