KCML_Session_SetTimeout

Purpose

Sets a session timeout callback

Definition

DEFSUB 'KCML_Session_SetTimeout(BYREF Set$_KCML_SESSION_SETTIMEOUT)) AS Bool

Parameters

Set	Structure containing the timeout periods and callback function for session timeouts.

Return

TRUE for success

Description

Sets a session timeout callback function to enable the application to react to inactive sessions or sessions where the client is no longer reachable. Setting both KCML_SESSION_SETTIMEOUT_Timeout and KCML_SESSION_SETTIMEOUT_KeepAlive to zero will produce an immediate timeout without pinging the client. Setting KCML_SESSION_SETTIMEOUT_Callback to zero will disable the timeout.

See also

Internal KCML Functions, Internally defined structures and Internally defined enumerations and constants.