Turnkey Client Timeout
No edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<message>Write the content here to display this box</message>
<message>Write the content here to display this box</message>
==== Background ====
==== Background ====
For running applications, the Turnkey server keeps an active memory space for each active client using a [[Streaming Client|Streaming app]]. As long as that client is active and has a connection, resources are held in the memory of the server. If you want your application to automatically move to an MVC page that doesn't require any server resources, use the Timeout features.
For running applications, the Turnkey server keeps an active memory space for each active client using a [[Documentation:Streaming Client|Streaming app]]. As long as that client is active and has a connection, resources are held in the memory of the server. If you want your application to automatically move to an MVC page that doesn't require any server resources, use the Timeout features.


==== How to Configure ====
==== How to Configure ====
Line 8: Line 8:
You can configure the timeout for the whole server or for individual pages, with the individual page setting taking precedence.
You can configure the timeout for the whole server or for individual pages, with the individual page setting taking precedence.


For the whole server, i.e. all pages, add a setting to [[TurnkeySettings|TurnkeySettings.xml]] like this:
For the whole server, i.e. all pages, add a setting to [[Documentation:TurnkeySettings|TurnkeySettings.xml]] like this:
  <TurnkeyTimeoutMinutes>1</TurnkeyTimeoutMinutes>  
  <TurnkeyTimeoutMinutes>1</TurnkeyTimeoutMinutes>  
For a specific page, set the tagged value [[Span.TurnkeyTimeoutMinutes|TurnkeyTimeoutMinutes]] on the ViewModel.
For a specific page, set the tagged value [[Documentation:Span.TurnkeyTimeoutMinutes|TurnkeyTimeoutMinutes]] on the ViewModel.


==== Timeout Page ====
==== Timeout Page ====
There is a built-in simple Timedout page that will be used by default.
There is a built-in simple Timedout page that will be used by default.


If you want to create a ViewModel with your own design, create a ViewModel called [[Timedout viewmodel|Timedout]] and it will be used when a user waits longer than the timeout setting.  
If you want to create a ViewModel with your own design, create a ViewModel called [[Documentation:Timedout viewmodel|Timedout]] and it will be used when a user waits longer than the timeout setting.  


'''Note!''' This page only works if it is an MVC page. '''See:''' [[MVC]]
'''Note!''' This page only works if it is an MVC page. '''See:''' [[Documentation:MVC|MVC]]


====== See also: [[Memory optimization]] ======
====== See also: [[Documentation:Memory optimization|Memory optimization]] ======
[[Category:MDriven Turnkey]]
[[Category:MDriven Turnkey]]
{{Edited|July|12|2024}}
{{Edited|July|12|2025}}

Latest revision as of 05:13, 31 January 2025

This page was created by Lars.olofsson@mdriven.net on 2023-06-01. Last edited by Stephanie@mdriven.net on 2025-01-31.

Background

For running applications, the Turnkey server keeps an active memory space for each active client using a Streaming app. As long as that client is active and has a connection, resources are held in the memory of the server. If you want your application to automatically move to an MVC page that doesn't require any server resources, use the Timeout features.

How to Configure

By default, no timeout is active. The timeout setting is then -1.

You can configure the timeout for the whole server or for individual pages, with the individual page setting taking precedence.

For the whole server, i.e. all pages, add a setting to TurnkeySettings.xml like this:

<TurnkeyTimeoutMinutes>1</TurnkeyTimeoutMinutes> 

For a specific page, set the tagged value TurnkeyTimeoutMinutes on the ViewModel.

Timeout Page

There is a built-in simple Timedout page that will be used by default.

If you want to create a ViewModel with your own design, create a ViewModel called Timedout and it will be used when a user waits longer than the timeout setting.

Note! This page only works if it is an MVC page. See: MVC

See also: Memory optimization