ServiceBusSessionProcessorOptions.SessionIdleTimeout Property

Reference

Definition

Namespace:: Azure.Messaging.ServiceBus

Assembly:: Azure.Messaging.ServiceBus.dll

Package:: Azure.Messaging.ServiceBus v7.17.5

Source:: ServiceBusSessionProcessorOptions.cs

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 to wait for a message to be received for the currently active session. After this time has elapsed, the processor will close the session and attempt to process another session. If not specified, the TryTimeout will be used.

public TimeSpan? SessionIdleTimeout { get; set; }

member this.SessionIdleTimeout : Nullable<TimeSpan> with get, set

Public Property SessionIdleTimeout As Nullable(Of TimeSpan)

Property Value

Nullable<TimeSpan>

Exceptions

ArgumentOutOfRangeException

A value that is not positive is attempted to be set for the property.

Remarks

If SessionIds is populated and MaxConcurrentSessions is greater or equal to the number of sessions specified in SessionIds, the session will not be closed when the idle timeout elapses. However, it will still control the amount of time each receive call waits.

Applies to