BrokeredMessage クラス

  • リファレンス

定義

名前空間:
Microsoft.ServiceBus.Messaging
アセンブリ:
Microsoft.ServiceBus.dll
パッケージ:
WindowsAzure.ServiceBus v6.2.2

Service Bus クライアント間の通信の単位を表します。

public sealed class BrokeredMessage : IDisposable, System.Xml.Serialization.IXmlSerializable
type BrokeredMessage = class
    interface IXmlSerializable
    interface IDisposable
Public NotInheritable Class BrokeredMessage
Implements IDisposable, IXmlSerializable
継承
Object
BrokeredMessage
実装
IDisposable IXmlSerializable

コンストラクター

BrokeredMessage()

BrokeredMessage クラスの新しいインスタンスを初期化します。
BrokeredMessage(Object)

DataContractSerializer と BrokeredMessage バイナリ XmlDictionaryWriter を使用して、特定のオブジェクトから クラスの新しいインスタンスを初期化します。
BrokeredMessage(Object, XmlObjectSerializer)

指定された XmlObjectSerializer を使用して特定のオブジェクトから BrokeredMessage を作成するコンストラクター
BrokeredMessage(Stream)

BrokeredMessage クラスの新しいインスタンスを初期化します。
BrokeredMessage(Stream, Boolean)

指定されたストリームを本体として使用して、 クラスの新しいインスタンス BrokeredMessage を初期化します。

プロパティ

ContentType

コンテンツ タイプを取得または設定します。
CorrelationId

関連付けの識別子を取得または設定します。
DeadLetterSource

Service Bus クライアント間の通信の単位を表します。
DeliveryCount

配信の数を取得します。
EnqueuedSequenceNumber

メッセージのエンキューされたシーケンス番号を取得または設定します。
EnqueuedTimeUtc

UTC で送信された時刻の日付と時刻を取得します。
ExpiresAtUtc

メッセージの有効期限が切れる日付と時刻を UTC で取得します。
ForcePersistence

メッセージを短時間メモリに保持するのではなく、データベースにすぐに永続化するかどうかを示す値を取得または設定します。 メッセージが高速でないキューまたはトピックに送信される場合、このプロパティは無視されます。
IsBodyConsumed

メッセージが使用されたかどうかを指定します。
Label

アプリケーション固有のラベルを取得または設定します。
LockedUntilUtc

キュー/サブスクリプションでメッセージがロックされるまでの日付と時刻を UTC で取得します。
LockToken

Service Bus によってこのメッセージに割り当てられたロック トークンを取得します。
MessageId

メッセージの識別子を取得または設定します。 これは、Service Bus が重複するメッセージを識別するために使用できるユーザー定義の値です (有効な場合)。
PartitionKey

セッション対応ではないキューまたはトピックにトランザクション メッセージを送信するためのパーティション キーを取得または設定します。
Properties

アプリケーション固有のメッセージ プロパティを取得します。
ReplyTo

応答するキューのアドレスを取得または設定します。
ReplyToSessionId

応答するセッション識別子を取得または設定します。
ScheduledEnqueueTimeUtc

メッセージをエンキューする日付と時刻を UTC で取得または設定します。 このプロパティは UTC で時刻を返します。プロパティを設定する場合は、指定された DateTime 値も UTC である必要があります。
SequenceNumber

Service Bus によってメッセージに割り当てられた一意の番号を取得します。
SessionId

セッションの識別子を取得または設定します。
Size

メッセージのサイズをバイト単位で取得します。
State

メッセージの状態を取得または設定します。
TimeToLive

有効な値に対するメッセージの時刻を取得または設定します。 これは、メッセージが Service Bus に送信されてから、メッセージが有効期限切れになるまでの間隔です。 その TimeToLive の値よりも古いメッセージは期限切れになり、メッセージ ストアに保持されません。 サブスクライバーは期限切れのメッセージを受信できません。TimeToLive はメッセージが受信できる最大有効期間ですが、その値は、宛先キューまたはサブスクリプションで指定された DefaultMessageTimeToLive エンティティを超えることはできません。 TimeToLive の値を小さく指定すると、個々のメッセージに適用されます。 ただし、メッセージで指定された大きな値は、エンティティの DefaultMessageTimeToLive 値によってオーバーライドされます。
To

アドレスへの送信を取得または設定します。
ViaPartitionKey

トランザクションを使用して転送キュー経由でメッセージを送信する場合のパーティション キー値を取得または設定します。

メソッド

Abandon()

ピーク ロックされたメッセージのロックを破棄します。
Abandon(IDictionary<String,Object>)

ピーク ロックされたメッセージのロックを破棄します。
AbandonAsync()

ピークロックされたメッセージのロックを非同期的に破棄します。
AbandonAsync(IDictionary<String,Object>)

ピークロックされたメッセージのロックを非同期的に破棄します。
Clone()

新しいメッセージとしてメッセージの複製を送信できるように、メッセージを複製します。
Complete()

メッセージの受信操作を完了し、メッセージを処理済みおよび削除済みとしてマークする必要があることを示します。
CompleteAsync()

メッセージの受信操作を非同期的に完了し、メッセージを処理済みおよび削除済みとしてマークする必要があることを示します。
DeadLetter()

メッセージを配信不能キューに移動します。
DeadLetter(IDictionary<String,Object>)

メッセージを配信不能キューに移動します。
DeadLetter(String, String)

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

メッセージを配信不能キューに非同期的に移動します。
DeadLetterAsync(IDictionary<String,Object>)

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

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

受信側がこのメッセージの処理を延期することを示します。
Defer(IDictionary<String,Object>)

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

受信側がこのメッセージの処理を延期することを非同期的に示します。
DeferAsync(IDictionary<String,Object>)

受信側がこのメッセージの処理を延期することを非同期的に示します。
Dispose()

アンマネージ リソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。
GetBody<T>()

バイナリ XmlDictionaryReaderを指定して を使用して、ブローカーメッセージ本文を指定された型のDataContractSerializerオブジェクトに逆シリアル化します。
GetBody<T>(XmlObjectSerializer)

Binary XmlObjectSerializer で DataContractSerializer を使用して、BrokeredMessage 本体を指定した型のオブジェクトに逆シリアル化します。
RenewLock()

メッセージのロックを更新します。
RenewLockAsync()

メッセージのロックを非同期的に更新します。
ToString()

現在のメッセージを表す文字列を返します。

明示的なインターフェイスの実装

IXmlSerializable.GetSchema()

このメソッドは予約されているため、使用できません。 IXmlSerializable インターフェイスを実装するときは、このメソッドから null (Visual Basic では Nothing) を返す必要があります。代わりに、カスタム スキーマを指定する必要がある場合は、XmlSchemaProviderAttribute を クラスに適用します。
IXmlSerializable.ReadXml(XmlReader)

XML 表現からオブジェクトを生成します。 このメソッドは内部使用のために予約されており、直接または間接的に使用しないでください (シリアライザーやフォーマッタの使用など)。
IXmlSerializable.WriteXml(XmlWriter)

オブジェクトを XML 表現に変換します。 このメソッドは内部使用のために予約されており、直接または間接的に使用しないでください (シリアライザーやフォーマッタの使用など)。

適用対象