EventHubConnectionOptions.ConnectionIdleTimeout Property

Reference

Definition

Namespace:: Azure.Messaging.EventHubs

Assembly:: Azure.Messaging.EventHubs.dll

Package:: Azure.Messaging.EventHubs v5.11.5

Package:: Azure.Messaging.EventHubs v5.12.0-beta.1

Source:: EventHubConnectionOptions.cs

Source:: EventHubConnectionOptions.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.

The amount of time to allow a connection to have no observed traffic before considering it idle and eligible to close.

public TimeSpan ConnectionIdleTimeout { get; set; }

member this.ConnectionIdleTimeout : TimeSpan with get, set

Public Property ConnectionIdleTimeout As TimeSpan

Property Value

TimeSpan

The default idle timeout is 60 seconds. The timeout must be a positive value.

Exceptions

ArgumentOutOfRangeException

Occurs when the requested timeout is negative.

Remarks

If a connection is closed due to being idle, the Event Hubs clients will automatically reopen the connection when it is needed for a network operation. An idle connection being closed does not cause client errors or interfere with normal operation.

It is recommended to use the default value unless your application has special needs and you've tested the impact of changing the idle timeout.

Applies to

Share via