Message.TimeToReachQueue Property

Reference

Definition

Namespace:: System.Messaging

Assembly:: System.Messaging.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the maximum amount of time for the message to reach the queue.

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

[System.ComponentModel.TypeConverter(typeof(System.Messaging.Design.TimeoutConverter))]
[System.Messaging.MessagingDescription("MsgTimeToReachQueue")]
public TimeSpan TimeToReachQueue { get; set; }

[<System.ComponentModel.TypeConverter(typeof(System.Messaging.Design.TimeoutConverter))>]
[<System.Messaging.MessagingDescription("MsgTimeToReachQueue")>]
member this.TimeToReachQueue : TimeSpan with get, set

Public Property TimeToReachQueue As TimeSpan

Property Value

TimeSpan

The time limit for the message to reach the destination queue, beginning from the time the message is sent. The default is InfiniteTimeout.

Attributes: TypeConverterAttribute MessagingDescriptionAttribute

Exceptions

InvalidOperationException

The message queue is filtered to ignore the TimeToReachQueue property.

ArgumentException

The value specified for TimeToReachQueue is invalid. It might represent a negative number.

Examples

The following code example gets and sets the value of a message's TimeToReachQueue property.

Remarks

If the interval specified by the TimeToReachQueue property expires before the message reaches its destination, Message Queuing discards the message in one of two ways. If the message's UseDeadLetterQueue property is true, the message is sent to the dead-letter queue. If UseDeadLetterQueue is false, the message is ignored

You can set the message's AcknowledgeType property to request that Message Queuing send a negative acknowledgment message back to the sending application if the message does not arrive before the timer expires.

If the TimeToReachQueue property is set to 0 seconds, Message Queuing tries once to send the message to its destination - if the queue is waiting for the message. If the queue is local, the message always reaches it.

If the value specified by the TimeToReachQueue property is greater than the value specified by the TimeToBeReceived property, TimeToBeReceived takes precedence.

When several messages are sent in a single transaction, Message Queuing uses the TimeToReachQueue property of the first message.

Applies to

Product	Versions
.NET Framework	1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1

Share via