This Blog Has Moved

This blog has moved to http://amalhashim.wordpress.com

Wednesday, June 17, 2009

Heart Beat Design Pattern - Keeping Webpage Session Alive

Sometimes you want your web page to 'stay alive'. That is, if a user is filling out a complicated form, you do not want the session to time out before they are finished.

It's not simply a matter of increasing the session timeout to a very large value. If you do that, the sessions would be left active in the server memory for hours—long after the visitors have left the site. Increasing the session timeout IS a solution… but not necessarily a good solution.

The goal is that the session should stay active as long as the web page is open on the client machine …even if there are no post backs to reset the session timer. When the web page is closed, the session should time out normally.

I implemented a solution for this: The client will "ping" the server at intervals of less than the session timeout which will reset the session timer. This is known as the Heartbeat design pattern.

For testing purposes, I set the Session Timeout to two minutes in web.config:

<system.web>
  <sessionState timeout="2">
sessionState>

To trace what is happening, I used a utility function called ODS (it's in a class called MiscUtilities):

/// ---- ODS ---------------------------------------
/// 
/// Output Debug String with time stamp.
/// 
 
public static void ODS(string Msg)
{
    String Out = String.Format("{0}  {1}", 
                       DateTime.Now.ToString("hh:mm:ss.ff"), Msg);
    System.Diagnostics.Debug.WriteLine(Out);
}

To watch the Session State events, I added debugging strings to the global.asax file:

<%@ Application Language="C#" %>
 
<script RunAt="server">
 
    void Application_Start(object sender, EventArgs e)
    {
        MiscUtilities.ODS("****ApplicationStart");
    }
    void Session_Start(object sender, EventArgs e)
    {
        MiscUtilities.ODS("Session_Start");
    }
    void Session_End(object sender, EventArgs e)
    {
        MiscUtilities.ODS("Session_End");
    }

Here are the details:

We need a method at the server for the client to call. We use a WebMethod.

1. There must be a ScriptManager on the page.
2. The ScriptManager must have EnablePageMethods set to true.
3. The WebMethod must be public and static.
4. The WebMethod must have the EnableSession attribute set to true.

<asp:ScriptManager ID="ScriptManager1" runat="server" 
    EnablePageMethods="true">
asp:ScriptManager>
 

public partial class _Default : System.Web.UI.Page
{
    [WebMethod(EnableSession=true ) ]
    public static void PokePage()
    {
        // called by client to refresh session
        MiscUtilities.ODS("Server: I am poked");       
    }

We need JavaScript at the client to call the server function at fixed intervals:

<script type="text/javascript">
 
    var HeartBeatTimer;
 
    function StartHeartBeat()
    {
        // pulse every 10 seconds
        if (HeartBeatTimer == null)
            HeartBeatTimer = setInterval("HeartBeat()", 1000 * 10);
    }
 
    function HeartBeat()
    {
        // note: ScriptManger must have: EnablePageMethods="true"
        Sys.Debug.trace("Client: Poke Server");
        PageMethods.PokePage();
    }

 
<body id="MyBody"  onload="StartHeartBeat();">

Here is what the output looks like without the heartbeat:

10:22:43.03 ****ApplicationStart
10:22:45.13 Session_Start
10:25:00.00 Session_End

Here is the output with the heartbeat:

10:26:06.10 ****ApplicationStart
10:26:08.05 Session_Start
Client: Poke Server
10:26:18.93 Server: I am poked
Client: Poke Server
10:26:28.95 Server: I am poked
Client: Poke Server
10:26:38.96 Server: I am poked
Client: Poke Server
10:26:48.98 Server: I am poked

. . . (lines deleted)

Client: Poke Server
10:29:59.45 Server: I am poked
Client: Poke Server
10:30:09.47 Server: I am poked
Client: Poke Server
10:30:19.48 Server: I am poked

. . . (lines deleted)

It looks like the session is staying alive while the client is idle: Excellent!

I hope someone finds this useful.

6 comments:

manish said...

i have a umberella asp.net website with tabs (links to 4 other asp.net sites). i want to have the sessions for all of them alive even if the user is working on one of the sites. How can i do this (if possible). Thanks in advance.

manish said...

i have a umberella asp.net website with tabs (links to 4 other asp.net sites). I am opening the page of the clicked tab in a iframe i want to have the sessions for all of them alive even if the user is working on one of the sites. How can i do this (if possible). Thanks in advance.

A.m.a.L Hashim said...

are they different asp.net application, or belongs to the same application?

jagwio said...

If they are different applications, you may be able tom implement this using a third-party state server, or maybe even using the built-in option of storing the session in an SQL database (but I'm not sure of the second option).

Richa lata said...

I am not using asp.net, but the heart beat design pattern is helpful in my case. Thanks !

Richa lata said...

I am not using asp.net, but the heart beat design pattern is helpful in my case. Thanks !