ServiceBusReceiver クラス

定義

名前空間:

Azure.Messaging.ServiceBus

アセンブリ:

Azure.Messaging.ServiceBus.dll

パッケージ:

Azure.Messaging.ServiceBus v7.17.5

Source:

ServiceBusReceiver.cs

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

public class ServiceBusReceiver : IAsyncDisposable

type ServiceBusReceiver = class
    interface IAsyncDisposable

Public Class ServiceBusReceiver
Implements IAsyncDisposable

継承

Object

ServiceBusReceiver

派生

Azure.Messaging.ServiceBus.ServiceBusSessionReceiver

実装

IAsyncDisposable

注釈

ServiceBusReceiverは、アプリケーションの有効期間中、またはによって作成された がServiceBusClient破棄されるまで、キャッシュして使用しても安全です。 アプリケーションがメッセージを定期的または半定期的に使用している場合は、受信側をキャッシュすることをお勧めします。 受信側は、ネットワーク、CPU、メモリの効率的な使用を確保する役割を担います。 アプリケーションのシャットダウン時に関連付けられている ServiceBusClient を呼び出DisposeAsync()すと、受信側で使用されるネットワーク リソースやその他のアンマネージド オブジェクトが適切にクリーンアップされます。

コンストラクター

ServiceBusReceiver()	モック作成のために クラスの ServiceBusReceiver 新しいインスタンスを初期化します。
ServiceBusReceiver(ServiceBusClient, String, ServiceBusReceiverOptions)	派生型で使用するために、 ServiceBusReceiver クラスの新しいインスタンスを初期化します。
ServiceBusReceiver(ServiceBusClient, String, String, ServiceBusReceiverOptions)	派生型で使用するために、 ServiceBusReceiver クラスの新しいインスタンスを初期化します。

プロパティ

EntityPath	受信側が接続されている Service Bus エンティティのパス。受信側が含まれる Service Bus 名前空間に固有です。
FullyQualifiedNamespace	受信側が関連付けられている完全修飾 Service Bus 名前空間。 これは と似ている {yournamespace}.servicebus.windows.net可能性があります。
Identifier	受信側クライアントを識別するために使用される名前。 または空の場合 null は、ランダムな一意の値が使用されます。
IsClosed	これが ServiceBusReceiver 閉じられているかどうかを示します。
PrefetchCount	キューまたはサブスクリプションから一括で要求され、処理が現在アクティブかどうかに関係なくローカルにキューに入れるメッセージの数。これは、受信側がサービス要求を待機するのではなく、ローカル キャッシュから受信できるようにすることでスループットを最大化することを目的としています
ReceiveMode	メッセージの ReceiveMode 受信方法を指定するために使用される 。

メソッド

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