LocalServiceSecuritySettings.InactivityTimeout Property

Reference

Definition

Namespace:: System.ServiceModel.Channels

Assembly:: System.ServiceModel.dll

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 duration to wait before the channel is closed due to inactivity.

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

public TimeSpan InactivityTimeout { get; set; }

member this.InactivityTimeout : TimeSpan with get, set

Public Property InactivityTimeout As TimeSpan

Property Value

TimeSpan

A TimeSpan that represents the duration to wait before the security session with the client is closed due to inactivity. The default is 2 minutes.

Exceptions

ArgumentOutOfRangeException

The property is set to a value less than 0.

Examples

This example shows how get the InactivityTimeout value.

TimeSpan inactivityTimeout = settings.InactivityTimeout;

Dim inactivityTimeout As TimeSpan = settings.InactivityTimeout

Remarks

In a secure conversation session, note that both this property and the ReceiveTimeout property on the binding affect session timeout. The shorter of the two determines when timeouts occur.

Session settings such as this one are applicable under any of the following conditions:

All client credential types for WSDualHttpBinding and NetTcpBinding.
If <reliableSession> element is enabled.
If <reliableSession> element is not enabled, on WSHttpBinding with UserName = true or ClientCredentials.Windows = true.

Session settings such as this one are not applicable under any of the following conditions:

For BasicHttpBinding.
For NetNamedPipeBinding.
If <reliableSession> element is not enabled, on WSHttpBinding with ClientCertificate = true or with none of the ClientCredentials properties set to true.

Applies to