MessageReceiver.PeekAsync メソッド

定義

オーバーロード

PeekAsync()

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

PeekAsync(Int32)

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

PeekAsync()

ソース:
MessageReceiver.cs

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

public System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Message> PeekAsync ();
abstract member PeekAsync : unit -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Message>
override this.PeekAsync : unit -> System.Threading.Tasks.Task<Microsoft.Azure.ServiceBus.Message>
Public Function PeekAsync () As Task(Of Message)

戻り値

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

実装

注釈

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

適用対象

PeekAsync(Int32)

ソース:
MessageReceiver.cs

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

public System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message>> PeekAsync (int maxMessageCount);
abstract member PeekAsync : int -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message>>
override this.PeekAsync : int -> System.Threading.Tasks.Task<System.Collections.Generic.IList<Microsoft.Azure.ServiceBus.Message>>
Public Function PeekAsync (maxMessageCount As Integer) As Task(Of IList(Of Message))

パラメーター

maxMessageCount
Int32

戻り値

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

実装

注釈

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

適用対象