ClientIdle Property  

Gets and sets the maximum number of seconds a client can be idle before the server terminates the session.


object.ClientIdle [ = seconds ]


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 60 seconds. Changing this value inside an event handler will change the timeout period for the active client session.

This property should only be accessed within an event handler such as OnConnect 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.

Data Type

Integer (Int32)

See Also

IdleTime Property, OnTimeout Event