ServiceBusReceiver.PeekMessageAsync メソッド

定義

名前空間:

Azure.Messaging.ServiceBus

アセンブリ:

Azure.Messaging.ServiceBus.dll

パッケージ:

Azure.Messaging.ServiceBus v7.17.5

ソース:

ServiceBusReceiver.cs

受信側またはメッセージ・ソースの状態を変更せずに、次のアクティブ ServiceBusReceivedMessage をフェッチします。

public virtual System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage> PeekMessageAsync (long? fromSequenceNumber = default, System.Threading.CancellationToken cancellationToken = default);

abstract member PeekMessageAsync : Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>
override this.PeekMessageAsync : Nullable<int64> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Messaging.ServiceBus.ServiceBusReceivedMessage>

Public Overridable Function PeekMessageAsync (Optional fromSequenceNumber As Nullable(Of Long) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ServiceBusReceivedMessage)

パラメーター

fromSequenceNumber

Nullable<Int64>

メッセージをピークする場所のシーケンス番号 (省略可能)。 これは、 に SequenceNumber対応します。

cancellationToken

CancellationToken

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

戻り値

Task<ServiceBusReceivedMessage>

ServiceBusReceivedMessage読み取る次のメッセージを表す 。 何もピークしない場合は null を返します。

注釈

を最初に呼び出すと PeekMessageAsync(Nullable<Int64>, CancellationToken) 、このレシーバーの最初のアクティブ メッセージがフェッチされます。 後続の呼び出しごとに、エンティティ内の後続のメッセージがフェッチされます。 受信したメッセージとは異なり、ピークされたメッセージにはロック トークンが関連付けられていないため、Completed/Abandoned/Deferred/Deadlettered/Renewed にすることはできません。 また、とは異なり ReceiveMessageAsync(Nullable<TimeSpan>, CancellationToken)、このメソッドは遅延メッセージもフェッチします (ただし、配信不能メッセージはフェッチしません)。