QueuePolicy.Overflow Property

[This is prerelease documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Gets or sets the overflow.

Namespace: Microsoft.ServiceBus
Assembly: Microsoft.ServiceBus (in microsoft.servicebus.dll)

Usage

    Dim instance As QueuePolicy
Dim value As OverflowPolicy

value = instance.Overflow

instance.Overflow = value

Syntax

'Declaration
Public Property Overflow As OverflowPolicy

public OverflowPolicy Overflow { get; set; }

public:
property OverflowPolicy Overflow {
    OverflowPolicy get ();
    void set (OverflowPolicy value);
}

/** @property */
public OverflowPolicy get_Overflow ()

/** @property */
public void set_Overflow (OverflowPolicy value)

public function get Overflow () : OverflowPolicy

public function set Overflow (value : OverflowPolicy)

Property Value

Returns OverflowPolicy. Contains the overflow policy.

Remarks

The overflow policy becomes relevant when the queue has reached capacity and the EnqueueTimeout for a newly arriving message has expired. The available options are as follows:

• DiscardExistingMessage – The Service Bus will dequeue and discard messages at the head of the queue until the new message can fit into the queue.

• DiscardIncomingMessage – The Service Bus will discard the newly arrived message without reporting back to the client

• RejectIncomingMessage – The Service Bus will reject the newly arriving message and respond to the client with a FaultException that indicates that the quota has been exceeded.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003 , Windows Server 2008, and Windows 2000

Target Platforms

See Also

Reference

QueuePolicy Class
QueuePolicy Members
Microsoft.ServiceBus Namespace