QueuePolicy.EnqueueTimeout Property

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

Gets or sets the enqueue timeout. The minimum value is 0, the default setting is 10 seconds, and the maximum value is 20 seconds.

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

Usage

    Dim instance As QueuePolicy
Dim value As TimeSpan

value = instance.EnqueueTimeout

instance.EnqueueTimeout = value

Syntax

'Declaration
Public Property EnqueueTimeout As TimeSpan

public TimeSpan EnqueueTimeout { get; set; }

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

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

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

public function get EnqueueTimeout () : TimeSpan

public function set EnqueueTimeout (value : TimeSpan)

Property Value

Returns TimeSpan. Contains the enqueue timeout.

Remarks

EnqueueTimeout is used whenever the Queue is at capacity and no further messages can be added to the Queue. In this condition, the system blocks all incoming requests with newly arriving messages for at most the specified amount of time. While the request blocks, the system submits the messages into the Queue once capacity to hold the message becomes available in the Queue. If the system cannot submit the messages into the Queue, the message is handled according to the effective OverflowPolicy.

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