This documentation is archived and is not being maintained.

SessionStateModule Class

Provides session-state services for an application. This class cannot be inherited.


Namespace:  System.Web.SessionState
Assembly:  System.Web (in System.Web.dll)

public sealed class SessionStateModule : IHttpModule

The SessionStateModule type exposes the following members.

Public methodSessionStateModuleInitializes a new instance of the SessionStateModule class.

Public methodDisposeExecutes final cleanup code before the SessionStateModule object is released from memory.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitCalls initialization code when a SessionStateModule object is created.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public eventEndOccurs when a session ends.
Public eventStartThe event that occurs when a session is created.

SessionStateModule is ASP.NET's default session-state handler. It writes session data to and retrieves it from the session-state store and raises the Session_OnStart and Session_OnEnd events. For details about how to use ASP.NET session state to store and retrieve values for a user session, see ASP.NET Session State Overview.

You can replace the SessionStateModule with a custom implementation of the IHttpModule interface that manages session state. For an example of a custom session-state module, see the SessionStateUtility class overview.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.