Edit

TcpConnectionPoolSettings.LeaseTimeout Property

  • Reference

Definition

Namespace:
System.ServiceModel.Channels
Assembly:
System.ServiceModel.NetTcp.dll
Assembly:
System.ServiceModel.dll
Package:
System.ServiceModel.NetTcp v6.0.0
Package:
System.ServiceModel.NetTcp v6.2.0
Package:
System.ServiceModel.NetTcp v8.0.0
Source:
TcpConnectionPoolSettings.cs
Source:
TcpConnectionPoolSettings.cs
Source:
TcpConnectionPoolSettings.cs

Gets or sets the time span after which a connection in the connection pool is closed.

public:
 property TimeSpan LeaseTimeout { TimeSpan get(); void set(TimeSpan value); };
public TimeSpan LeaseTimeout { get; set; }
member this.LeaseTimeout : TimeSpan with get, set
Public Property LeaseTimeout As TimeSpan

Property Value

TimeSpan

Returns a TimeSpan structure that indicates the time span after which a cached TCP connection is purged from the connection pool.

Exceptions

ArgumentOutOfRangeException

The value cannot be less than zero.

Remarks

This property bounds the overall lifetime of a socket. Once a socket has been around longer than LeaseTimeout, it is closed as soon as it is returned to the connection pool. The connection cache used by the TCP transport creates new connections as required for each endpoint up to the cache limit that is set by MaxOutboundConnectionsPerEndpoint.

Applies to