virtual void OnTimeout(
	UINT nClientId,
	UINT nIdleTime,
	UINT nElapsed
);

A virtual method that is invoked after the client has exceeded the maximum allowed idle time.

Parameters

nClientId

An unsigned integer which uniquely identifies the client session.

nIdleTime

An unsigned integer value that specifies the current idle timeout period for the client in seconds.

nElapsed

An unsigned integer value that specifies the number of seconds that the client has been idle.

Return Value

None.

Remarks

The OnTimeout event handler is invoked after the client has has exceeded the maximum allowed idle time. To implement an event handler, the application should create a class derived from the CHttpServer class, and then override this method.

This event handler will be invoked prior to the client being disconnected from the server. This event will never occur while the server is returning data to the client. The SetClientIdleTime method can be used to change or refresh the idle timeout period for the session.

Requirements

Minimum Desktop Platform: Windows 7 (Service Pack 1)
Minimum Server Platform: Windows Server 2008 R2 (Service Pack 1)
Header File: cstools10.h
Import Library: cshtsv10.lib

See Also

GetClientIdleTime, OnCommand, OnResult, SetClientIdleTime

Copyright © 2023 Catalyst Development Corporation. All rights reserved.