MessageReceiver クラス

定義

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

public abstract class MessageReceiver : Microsoft.ServiceBus.Messaging.MessagingEntityClient
type MessageReceiver = class
    inherit MessagingEntityClient
Public MustInherit Class MessageReceiver
Inherits MessagingEntityClient
継承
派生

注釈

メッセージ配信メカニズムでは、常に信頼できるメッセージ受信が既定で提供されるわけではありません。 Service Bus は、システムから出るとメッセージを削除します。 保証された配信には、PeekLock 配信モードを使用できます。

//********************************************************************************
//                             Sending messages to a Queue
//********************************************************************************

// Create a sender
MessageSender myMessageSender = myQueueClient.CreateSender(SendMode.Default);

// Send messages
List<string> Issues = new List<string>();
foreach (var issue in Issues)
{
myMessageSender.Send(new BrokeredMessage(issue));
}
//********************************************************************************
//                           Recieving messages from a Queue
//********************************************************************************

// Create a receiver
MessageReceiver myMessageReceiver = 
myQueueClient.CreateReceiver(ReceiveMode.PeekLock);

// Receive messages
for (int count = 0; count < Issues.Count; count++)
{
var message = myMessageReceiver.Receive();
message.Complete();
}
//********************************************************************************
//                    Receiving messages from a particular session
//********************************************************************************

// Create subscription client
SubscriptionClient mySubscriptionClient = factory.CreateSubscriptionClient(mySubscription);

// Create a receiver
MessageReceiver myMessageReceiver = mySubscriptionClient.AcceptMessageSession(ReceiveMode.PeekLock);

// Receive messages
for (int count = 0; count *lt; Issues.Count; count++)
{
var message = myMessageReceiver.Receive();
message.Complete();
}

プロパティ

BatchFlushInterval

バッチフラッシュ間隔を取得します。

BatchingEnabled

バッチ処理が有効かどうかを示す値を取得します。

IsClosed

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
LastPeekedSequenceNumber

最後にピークしたメッセージのシーケンス番号を取得または設定します。

Mode

メッセージ受信モードを取得します。

Path

ベース アドレスに対するキュー、トピック、またはサブスクリプションのパスを MessagingFactory 取得します。

(継承元 MessagingEntityClient)
PrefetchCount

メッセージの受信者が同時に要求できるメッセージ数を取得または設定します。

RefreshEntityRuntimeDescription

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

RetryPolicy

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
SupportsGetRuntimeEntityDescription

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

ThisLock

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)

メソッド

Abandon(Guid)

メッセージを破棄し、メッセージ ロックの所有権を放棄します。

Abandon(Guid, IDictionary<String,Object>)

メッセージを破棄し、メッセージ ロックの所有権を放棄します。

AbandonAsync(Guid)

メッセージを非同期的に破棄し、メッセージ ロックの所有権を放棄します。

AbandonAsync(Guid, IDictionary<String,Object>)

メッセージを非同期的に破棄し、メッセージ ロックの所有権を放棄します。

Abort()

メッセージング エンティティに対して中止機能を実行します。

(継承元 ClientEntity)
Close()

クリーンアップ メッセージを Service Bus に送信して、エンティティの使用の完了を通知します。

(継承元 ClientEntity)
CloseAsync()

クリーンアップ メッセージを Service Bus に非同期的に送信して、エンティティの使用の完了を通知します。

(継承元 ClientEntity)
Complete(Guid)

メッセージの受信操作を完了します。 AMQP を使用している場合、この操作は、このレシーバーによって受信されたメッセージに対してのみ実行できます。

CompleteAsync(Guid)

メッセージの受信操作を非同期に完了します。 AMQP を使用している場合、この操作は、このレシーバーによって受信されたメッセージに対してのみ実行できます。

CompleteBatch(IEnumerable<Guid>)

メッセージのバッチに対する受信操作を完了します。 AMQP を使用している場合、この操作は、このレシーバーによって受信されたメッセージに対してのみ実行できます。

CompleteBatchAsync(IEnumerable<Guid>)

メッセージのバッチに対する受信操作を非同期的に完了します。 AMQP を使用している場合、この操作は、このレシーバーによって受信されたメッセージに対してのみ実行できます。

DeadLetter(Guid)

配信不能メッセージを配信不能キューに移動します。

DeadLetter(Guid, IDictionary<String,Object>)

配信不能メッセージを配信不能キューに移動します。

DeadLetter(Guid, String, String)

配信不能メッセージを配信不能キューに移動します。

DeadLetterAsync(Guid)

配信不能メッセージを配信不能キューに非同期的に移動します。

DeadLetterAsync(Guid, IDictionary<String,Object>)

配信不能メッセージを配信不能キューに非同期的に移動します。

DeadLetterAsync(Guid, String, String)

配信不能メッセージを配信不能キューに非同期的に移動します。

Defer(Guid)

受信側がメッセージの処理を延期することを示します。

Defer(Guid, IDictionary<String,Object>)

受信側がメッセージの処理を延期することを示します。

DeferAsync(Guid)

メッセージの処理を非同期的に延期します。

DeferAsync(Guid, IDictionary<String,Object>)

メッセージの処理を非同期的に延期します。

Fault()

内部使用専用です。 このクラスから継承しないでください。

(継承元 ClientEntity)
GetLockToken(BrokeredMessage)

メッセージにバインドされているロック トークンを取得します。

GetLockTokens(IEnumerable<BrokeredMessage>)

指定したメッセージのコレクションからロック トークンのコレクションを取得します。

GetProperty<T>()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

OnAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, TimeSpan)

破棄アクションを実行します。

OnAbort()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnBeginAbandon(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, Boolean, TimeSpan, AsyncCallback, Object)

OnAbandon または BeginAbandon 操作の呼び出し時に実行されます。

OnBeginClose(TimeSpan, AsyncCallback, Object)

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnBeginComplete(TrackingContext, IEnumerable<ArraySegment<Byte>>, Boolean, TimeSpan, AsyncCallback, Object)

OnComplete または BeginComplete 操作の呼び出し時に実行されます。

OnBeginComplete(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object)

OnComplete または BeginComplete 操作の呼び出し時に実行されます。

OnBeginDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, Boolean, TimeSpan, AsyncCallback, Object)

OnDeadLetter または BeginDeadLetter 操作の呼び出し時に実行されます。

OnBeginDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, Boolean, TimeSpan, AsyncCallback, Object)

OnDefer または BeginDefer 操作の呼び出し時に実行されます。

OnBeginOpen(TimeSpan, AsyncCallback, Object)

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnBeginPeek(TrackingContext, Int64, Int32, TimeSpan, AsyncCallback, Object)

BeginPeek 操作の呼び出し時に実行されます。

OnBeginRenewMessageLocks(TrackingContext, IEnumerable<Guid>, Boolean, TimeSpan, AsyncCallback, Object)

ロック メッセージの OnBegin 操作の呼び出し時に実行されます。

OnBeginTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, AsyncCallback, Object)

begin try receive アクションを実行します。

OnBeginTryReceive(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)

begin try receive アクションを実行します。

OnBeginTryReceive2(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)

begin try receive アクションを実行します。

OnBeginTryReceiveEventData(TrackingContext, Int32, TimeSpan, AsyncCallback, Object)

イベント データに対して OnTryReceive または BeginTryReceive 操作を呼び出したときに実行されます。

OnClose(TimeSpan)

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnClosed()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnComplete(TrackingContext, IEnumerable<Guid>, TimeSpan)

完全なアクションを実行します。

OnDeadLetter(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, String, String, TimeSpan)

配信不能キューへの移動アクションを実行します。

OnDefer(TrackingContext, IEnumerable<Guid>, IDictionary<String,Object>, TimeSpan)

遅延アクションを実行します。

OnEndAbandon(IAsyncResult)

終了破棄アクションを実行します。

OnEndClose(IAsyncResult)

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnEndComplete(IAsyncResult)

完了終了アクションを実行します。

OnEndDeadLetter(IAsyncResult)

配信不能キューへの移動の終了アクションを実行します。

OnEndDefer(IAsyncResult)

終了遅延アクションを実行します。

OnEndOpen(IAsyncResult)

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnEndPeek(IAsyncResult)

EndPeek 操作を実行します。

OnEndRenewMessageLocks(IAsyncResult)

メッセージ ロックに対して EndRenew アクションを実行します。

OnEndTryReceive(IAsyncResult, IEnumerable<BrokeredMessage>)

end try receive アクションを実行します。

OnEndTryReceive2(IAsyncResult, IEnumerable<BrokeredMessage>)

end try receive アクションを実行します。

OnEndTryReceiveEventData(IAsyncResult, IEnumerable<EventData>)

イベント データの EndTryReceive アクションを実行します。

OnFaulted()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnMessage(Action<BrokeredMessage>, OnMessageOptions)

イベント ドリブン メッセージ ポンプでメッセージを処理します。

OnMessageAsync(Func<BrokeredMessage,Task>, OnMessageOptions)

イベント ドリブン メッセージ ポンプでメッセージを非同期に処理します。

OnOpen(TimeSpan)

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnOpened()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
OnPeek(TrackingContext, Int64, Int32, TimeSpan)

Peek 操作の呼び出し時に実行されます。

OnRenewMessageLocks(TrackingContext, IEnumerable<Guid>, TimeSpan)

ロック メッセージの更新アクションを実行します。

OnTryReceive(TrackingContext, IEnumerable<Int64>, TimeSpan, IEnumerable<BrokeredMessage>)

try receive アクションを実行します。

OnTryReceive(TrackingContext, Int32, TimeSpan, IEnumerable<BrokeredMessage>)

try receive アクションを実行します。

Peek()

受信側またはメッセージ ソースの状態を変更せずに、次のメッセージを読み取ります。

Peek(Int64)

受信側またはメッセージ ソースの状態を変更せずに、次のメッセージを読み取ります。

PeekAsync()

受信側またはメッセージ ソースの状態を変更せずに、次のメッセージを非同期に読み取ります。

PeekAsync(Int64)

受信側またはメッセージ ソースの状態を変更せずに、次のメッセージを非同期に読み取ります。

PeekBatch(Int32)

受信者またはメッセージ ソースの状態を変更せずに、メッセージの次のバッチを読み取ります。

PeekBatch(Int64, Int32)

受信者またはメッセージ ソースの状態を変更せずに、メッセージの次のバッチを読み取ります。

PeekBatchAsync(Int32)

受信側またはメッセージ ソースの状態を変更せずに、メッセージの次のバッチを非同期に読み取ります。

PeekBatchAsync(Int64, Int32)

受信側またはメッセージ ソースの状態を変更せずに、メッセージの次のバッチを非同期に読み取ります。

Receive()

現在の BrokeredMessage キューまたはトピックから を受信します。

Receive(Int64)

現在のキューまたはトピックから遅延メッセージを受信します。 このメソッドは、通常のメッセージではなく、遅延メッセージに対してのみ機能します。

Receive(TimeSpan)

現在の BrokeredMessage キューまたはトピックから を受信します。

ReceiveAsync()

現在のキューまたはトピックからメッセージを非同期に受信します。

ReceiveAsync(Int64)

現在のキューまたはトピックから遅延メッセージを非同期に受信します。 このメソッドは、通常のメッセージではなく、遅延メッセージに対してのみ機能します。

ReceiveAsync(TimeSpan)

現在のキューまたはトピックからメッセージを非同期に受信します。

ReceiveBatch(IEnumerable<Int64>)

メッセージのバッチを受信します。

ReceiveBatch(Int32)

メッセージのバッチを受信します。

ReceiveBatch(Int32, TimeSpan)

メッセージのバッチを受信します。

ReceiveBatchAsync(IEnumerable<Int64>)

メッセージのバッチを非同期的に受信します。

ReceiveBatchAsync(Int32)

メッセージのバッチを非同期的に受信します。

ReceiveBatchAsync(Int32, TimeSpan)

メッセージのバッチを非同期的に受信します。

ThrowIfClosed()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
ThrowIfDisposed()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
ThrowIfDisposedOrImmutable()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
ThrowIfDisposedOrNotOpen()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)
ThrowIfFaulted()

MessageReceiver クラスは、メッセージ コンテナーからメッセージを受信し、それらを確認するために使用されます。

(継承元 ClientEntity)

適用対象