ServiceBusSessionReceiver クラス

定義

名前空間:

Azure.Messaging.ServiceBus

アセンブリ:

Azure.Messaging.ServiceBus.dll

パッケージ:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusSessionReceiver.cs

は ServiceBusSessionReceiver 、セッションが有効なキューとサブスクリプションからのメッセージの受信 ServiceBusReceivedMessage と解決を担当します。 これは、 を呼び出 AcceptNextSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)すことによって構築されます。

public class ServiceBusSessionReceiver : Azure.Messaging.ServiceBus.ServiceBusReceiver

type ServiceBusSessionReceiver = class
    inherit ServiceBusReceiver

Public Class ServiceBusSessionReceiver
Inherits ServiceBusReceiver

継承

Object

ServiceBusReceiver

ServiceBusSessionReceiver

コンストラクター

ServiceBusSessionReceiver()

モック作成のために クラスの ServiceBusSessionReceiver 新しいインスタンスを初期化します。

プロパティ

EntityPath	受信側が接続されている Service Bus エンティティのパス。受信側が含まれる Service Bus 名前空間に固有です。 (継承元 ServiceBusReceiver)
FullyQualifiedNamespace	受信側が関連付けられている完全修飾 Service Bus 名前空間。 これは と似ている {yournamespace}.servicebus.windows.net可能性があります。 (継承元 ServiceBusReceiver)
Identifier	受信側クライアントを識別するために使用される名前。 または空の場合 null は、ランダムな一意の値が使用されます。 (継承元 ServiceBusReceiver)
IsClosed	これが ServiceBusSessionReceiver ユーザーによって閉じられたかどうか、またはセッション ロックが失われたか、リンクが切断されたために基になるセッション リンクが閉じられたかどうかを示します。 が の場合、 trueレシーバーはそれ以上の操作には使用できません。 が falseの場合でも、セッション ロックが失われている可能性があるため、 と等しい SessionLockLostを使用して処理ServiceBusExceptionReasonすることが重要です。
PrefetchCount	キューまたはサブスクリプションから一括で要求され、処理が現在アクティブかどうかに関係なくローカルにキューに入れるメッセージの数。これは、受信側がサービス要求を待機するのではなく、ローカル キャッシュから受信できるようにすることでスループットを最大化することを目的としています (継承元 ServiceBusReceiver)
ReceiveMode	メッセージの ReceiveMode 受信方法を指定するために使用される 。 (継承元 ServiceBusReceiver)
SessionId	受信側に関連付けられているセッション ID。
SessionLockedUntil	受信側の DateTimeOffset セッションがロックされるまでロックされている を取得します。

メソッド

AbandonMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	を破棄します ServiceBusReceivedMessage。これにより、受信側が保持するメッセージのロックが解除されるため、メッセージをすぐに処理できるようになります。 (継承元 ServiceBusReceiver)
CloseAsync(CancellationToken)	によって使用されるリソースをクリーンするために必要なタスクを実行しますServiceBusReceiver。 (継承元 ServiceBusReceiver)
CompleteMessageAsync(ServiceBusReceivedMessage, CancellationToken)	を完了します ServiceBusReceivedMessage。 これにより、サービスからメッセージが削除されます。 (継承元 ServiceBusReceiver)
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	配信不能サブキューにメッセージを移動します。 (継承元 ServiceBusReceiver)
DeadLetterMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, String, String, CancellationToken)	配信不能サブキューにメッセージを移動します。 (継承元 ServiceBusReceiver)
DeadLetterMessageAsync(ServiceBusReceivedMessage, String, String, CancellationToken)	配信不能サブキューにメッセージを移動します。 (継承元 ServiceBusReceiver)
DeferMessageAsync(ServiceBusReceivedMessage, IDictionary<String,Object>, CancellationToken)	受信側がメッセージの処理を延期することを示します。 (継承元 ServiceBusReceiver)
DisposeAsync()	によって使用されるリソースをクリーンするために必要なタスクを実行しますServiceBusReceiver。 これは、 を呼び出すこと CloseAsync(CancellationToken)と同じです。 (継承元 ServiceBusReceiver)
GetSessionStateAsync(CancellationToken)	セッションの状態を取得します。
PeekMessageAsync(Nullable<Int64>, CancellationToken)	受信側またはメッセージ ソースの状態を変更せずに、次のアクティブ ServiceBusReceivedMessage をフェッチします。 (継承元 ServiceBusReceiver)
PeekMessagesAsync(Int32, Nullable<Int64>, CancellationToken)	は ServiceBusSessionReceiver 、セッションが有効なキューとサブスクリプションからのメッセージの受信 ServiceBusReceivedMessage と解決を担当します。 これは、 を呼び出 AcceptNextSessionAsync(String, String, ServiceBusSessionReceiverOptions, CancellationToken)すことによって構築されます。 (継承元 ServiceBusReceiver)
ReceiveDeferredMessageAsync(Int64, CancellationToken)	によって sequenceNumber識別される遅延メッセージを受信します。 (継承元 ServiceBusReceiver)
ReceiveDeferredMessagesAsync(IEnumerable<Int64>, CancellationToken)	によって sequenceNumbers識別される遅延メッセージの一覧を受信します。 (継承元 ServiceBusReceiver)
ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)	モードを ServiceBusReceivedMessage 使用して ReceiveMode エンティティから を受け取ります。 ReceiveMode の既定値は PeekLock モードです。 (継承元 ServiceBusReceiver)
ReceiveMessagesAsync(CancellationToken)	モードを使用してエンティティから非同期列挙可能としてメッセージを ReceiveMode 受信します。 ReceiveMode の既定値は PeekLock モードです。 IAsyncEnumerable が反復処理されると、エンティティからメッセージが受信されます。 使用可能なメッセージがない場合、このメソッドはメッセージが使用可能になるまでポーリングを続行します。つまり、null を返すことはありません。 (継承元 ServiceBusReceiver)
ReceiveMessagesAsync(Int32, Nullable<TimeSpan>, CancellationToken)	モードを使用して、エンティティから の ServiceBusReceivedMessage 一覧を ReceiveMode 受け取ります。 ReceiveMode の既定値は PeekLock モードです。 このメソッドは、キューまたはトピックに使用可能なメッセージがあるmaxMessages場合でも、正確なmaxMessagesメッセージを返す保証はありません。 (継承元 ServiceBusReceiver)
RenewMessageLockAsync(ServiceBusReceivedMessage, CancellationToken)	メッセージのロックを更新します。 ロックは、キューで指定された設定に基づいて更新されます。 (継承元 ServiceBusReceiver)
RenewSessionLockAsync(CancellationToken)	で指定されたセッションのロックを更新します SessionId。 ロックは、エンティティで指定された設定に基づいて更新されます。
SetSessionStateAsync(BinaryData, CancellationToken)	後で を使用して取得できるカスタム状態をセッションに設定する GetSessionStateAsync(CancellationToken)