Message.TimeToBeReceived プロパティ

.NET Framework クラス ライブラリ リファレンス

Message.TimeToBeReceived プロパティ

メッセージが送信先キューから受信されるまでの最大許容時間を取得または設定します。

名前空間: System.Messaging
アセンブリ: System.Messaging (system.messaging.dll 内)
構文

Visual Basic (宣言)

Public Property TimeToBeReceived As
 TimeSpan

Visual Basic (使用法)

Dim instance As Message
Dim value As TimeSpan

value = instance.TimeToBeReceived

instance.TimeToBeReceived = value

C#

public TimeSpan TimeToBeReceived { get; set;
 }

C++

public:
property TimeSpan TimeToBeReceived {
    TimeSpan get ();
    void set (TimeSpan value);
}

J#

/** @property */
public TimeSpan get_TimeToBeReceived ()

/** @property */
public void set_TimeToBeReceived (TimeSpan
 value)

JScript

public function get TimeToBeReceived
 () : TimeSpan

public function set TimeToBeReceived
 (value : TimeSpan)

プロパティ値
送信されたメッセージが送信先キューから受信されるまでの合計時間。既定値は InfiniteTimeout です。

例外

例外の種類	条件
InvalidOperationException	フィルタ処理されたメッセージ キューが、TimeToBeReceived プロパティを無視します。
ArgumentException	TimeToBeReceived に指定された値が無効です。

解説

TimeToBeReceived プロパティは、送信されたメッセージが送信先キューから受信されるまでの合計時間を指定します。このタイム リミットには、送信先キューに到達するまでにかかる時間と、メッセージが受信されるまでキュー内にとどまっている時間とが含まれます。

注意
依存型クライアント コンピュータを使用するときには、メッセージ キューを実行しているサーバーのクロックにクライアント コンピュータのクロックを必ず同期させてください。同期していない場合、TimeToBeReceived プロパティが InfiniteTimeout でないメッセージを送信したときに予測できない動作が発生することがあります。

キューからメッセージが削除される前に TimeToBeReceived プロパティによって指定される間隔が終了すると、メッセージ キューは次のどちらかの方法でそのメッセージを破棄します。メッセージの UseDeadLetterQueue プロパティが true の場合、メッセージは配信不能キューに送信されます。UseDeadLetterQueue が false の場合、メッセージは無視されます。

メッセージの AcknowledgeType プロパティを設定すると、タイマが時間切れになるまでにメッセージが取得されない場合に、メッセージ キューが送信元アプリケーションに否定受信確認メッセージを返すように要求できます。

TimeToBeReceived プロパティによって指定される値が TimeToReachQueue プロパティによって指定される値より小さいときは、TimeToBeReceived が適用されます。

1 つのトランザクションで複数のメッセージが送信されるときには、メッセージ キューは最初のメッセージの TimeToBeReceived プロパティを使います。

使用例

メッセージの TimeToBeReceived プロパティに対し、値の取得と設定を行うコード例を次に示します。

C#

// Set the message's TimeToBeReceived property to five minutes.
orderMessage.TimeToBeReceived = TimeSpan.FromMinutes(5.0);

// Display the new value of the message's TimeToBeReceived property.
Console.WriteLine("Message.TimeToBeReceived: {0}",
    orderMessage.TimeToBeReceived.ToString());

C++

// Set the message's TimeToBeReceived property to five minutes.
orderMessage->TimeToBeReceived = TimeSpan::FromMinutes(5.0);

// Display the new value of the message's TimeToBeReceived property.
Console::WriteLine("Message.TimeToBeReceived: {0}",
    orderMessage->TimeToBeReceived.ToString());

J#

// Set the message's TimeToBeReceived property to five minutes.
orderMessage.set_TimeToBeReceived(TimeSpan.FromMinutes(5.0));
// Display the new value of the message's TimeToBeReceived property.
Console.WriteLine("Message.TimeToBeReceived: {0}", 
    orderMessage.get_TimeToBeReceived().ToString());

.NET Framework のセキュリティ

• 直前の呼び出し元に対する完全な信頼。このメンバは、部分的に信頼されているコードから使用することはできません。詳細については、「」を参照してください。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
Message クラス
Message メンバ
System.Messaging 名前空間
TimeToReachQueue
InfiniteTimeout