AF SDK Reference

AFConnectionInfo.IdleTimeout Property

Save PDF

AFConnectionInfo.IdleTimeout Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Read-only property that is the connection idle timeout used to reset the connection to the PI AF Server for this PISystem.

Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public TimeSpan IdleTimeout { get; }

Public ReadOnly Property IdleTimeout As TimeSpan
	Get

Dim instance As AFConnectionInfo
Dim value As TimeSpan

value = instance.IdleTimeout

public:
property TimeSpan IdleTimeout {
	TimeSpan get ();
}

member IdleTimeout : TimeSpan with get

Property Value

Type: TimeSpan
If the connection to the PI AF Server for this PISystem is idle longer than this timeout setting, then the connection will be reset on the next call to the server. A time span of Zero will disable the idle timeout. The default value is eighteen (18) minutes.

Remarks

The value of this property is defined by the idleTimeout application setting in the server's configuration file.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

AF SDK Reference