QueuePolicy.MaxQueueCapacity Property

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

Gets or sets the maximum queue capacity.

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

Usage

    Dim instance As QueuePolicy
Dim value As Long

value = instance.MaxQueueCapacity

Syntax

'Declaration
Public Property MaxQueueCapacity As Long

public long MaxQueueCapacity { get; }

public:
property long long MaxQueueCapacity {
    long long get ();
}

/** @property */
public long get_MaxQueueCapacity ()

public function get MaxQueueCapacity () : long

Property Value

Returns the maximum queue capacity.

Remarks

The Queue Capacity is an upper bound for how many bytes can be held by the Queue, which includes all internal overhead and any non-payload message overhead such as headers. The maximum capacity is a calculated value that is a product of the MaxQueueLength and MaxMessageSize. The absolute upper limit for the Queue Capacity is defined by the Service Bus service. If the calculated maximum capacity exceeds the system-imposed limit, the capacity is adjusted to the system limit.

Once the maximum queue capacity is reached, any additionally enqueued messages are handled according to the EnqueueTimeout and OverflowPolicy policy settings.

The maximum system-defined queue capacity for the current CTP release of the Service Bus is 10 Mbytes.

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