MessagePropertyFilter.Recoverable Property

Definition

Namespace:

System.Messaging

Assembly:

System.Messaging.dll

Gets or sets a value that indicates whether to retrieve Recoverable property information when receiving or peeking a message.

public:
 property bool Recoverable { bool get(); void set(bool value); };

[System.Messaging.MessagingDescription("MsgRecoverable")]
public bool Recoverable { get; set; }

[<System.Messaging.MessagingDescription("MsgRecoverable")>]
member this.Recoverable : bool with get, set

Public Property Recoverable As Boolean

Property Value

Boolean

true to receive Recoverable information; otherwise, false. The default is false.

Attributes

MessagingDescriptionAttribute

Examples

The following code example demonstrates the use of the Recoverable property.

// Set the queue's MessageReadPropertyFilter property 
// to enable the message's Recoverable property.
queue->MessageReadPropertyFilter->Recoverable = true;

// Peek at the message. Time out after ten seconds 
// in case the message was not delivered.
orderMessage = queue->Peek(TimeSpan::FromSeconds(10.0));

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

// Set the queue's MessageReadPropertyFilter property to enable the
// message's Recoverable property.
queue.MessageReadPropertyFilter.Recoverable = true;

// Peek at the message. Time out after ten seconds in case the message
// was not delivered.
orderMessage = queue.Peek(TimeSpan.FromSeconds(10.0));

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

Remarks

The Recoverable property of the Message class indicates whether delivery of a message is guaranteed, even if a computer crashes while the message is en route to the destination queue.

If delivery of a message is guaranteed, the message is stored locally at every step until the message is successfully forwarded to the next computer. Setting Message.Recoverable to true on the message could affect the throughput.

See also

• Recoverable
• MessageQueue