PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN
This content has been translated automatically. Click here to view the French version.
  • Principle
  • Notes
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
SessionHeartBeatEnable (Function)
In french: SessionHeartBeatActive
Enables or disables the "heartbeat" of the current session.
Remark: By Default ; the
Example
SessionHeartBeatEnable(True, 10Min)
Syntax
SessionHeartBeatEnable(<Active> [, <Interval>])
<Active>: Boolean
  • True to enable the heartbeat,
  • False to disable it.
<Interval>: Optional duration or string
Interval between two calls. This parameter can correspond to:
  • a Duration variable,
  • the duration in a readable format (e.g., 5min).
By default, the interval is 5 minutes (unless the session timeout is shorter).
Remark: the WEBDEV application server waits for 1 minute in all cases, whatever the interval configured. The interval specified by this parameter is therefore always increased by this minute of waiting.
Remarks

Principle

The purpose of the session heartbeat is to reduce server load by closing sessions earlier (for example, by detecting sessions where the user is offsite).
The HeartBeat feature is an automatic process on the browser that regularly sends information to the server (e.g. every 5 minutes) to indicate that the browser is open. Once the user has closed the browser, the server no longer receives this HeartBeat and can therefore close the session immediately, without waiting for the timeout.
Caution: The HeartBeat does not allow extending the session beyond the idle user timeout (defined in the WEBDEV Application Server). If you set a session timeout to 10 minutes, the session will be closed after 10 minutes without an action from the user, even if the browser is still open.
Therefore, choosing the right interval is essential:
  • If the interval is too big, sessions remain open for too long.
  • If the interval is too short, the server is unnecessarily loaded with heartbeat calls to keep the sessions alive.
Caution: These heartbeat calls consume resources (network and battery) in the case of mobile clients.
The WEBDEV Application Server tries to dynamically detect if session maintenance is available. Sessions are ended sooner only if the application server detects that the page displayed on the client side is a page from the site. Otherwise, (e.g. an external payment page is displayed), sessions are not ended.

Notes

  • The call of the SessionHeartBeatEnable function is taken into account from the next page returned by the WEBDEV application server.
  • If the setting is to be applied to all pages of a site, the SessionHeartBeatEnable function must be called in the initialization code of the project, or of the first page (or any code called before the first page is returned).
  • The SessionHeartBeatEnable function also activates the heartbeat in test mode (project GB or page GB). It is usually not taken into account because the closing of the browser is detected by the test mode and the session is immediately ended.
Component: wd270page.dll
Minimum version required
  • Version 26
Comments
Click [Add] to post a comment