The ClientIdle property returns the maximum number of
seconds that the active client session may be idle before the server
closes the control connection. The idle timeout period for each
client session is based on the value of the IdleTime property
when the server was started, with the default value of 900 seconds
(15 minutes). Changing this value inside an event handler will
change the timeout period for the active client session. Clients
may also use the SITE IDLE command to request that the server
change the idle timeout period.
This property should only be accessed within an event handler such
as OnConnect or OnLogin because its value is specific to
the client session that raised the event. This property will always
return a value of zero outside of an event handler, and an exception
will be raised if you attempt to modify this property outside of an
event handler.
When the timeout period for the client has elapsed, the
OnTimeout event will fire prior to the client being disconnected
from the server.