DataCacheSessionStoreProvider Class

 

Note: This API is now obsolete.

A session storage provider that enables Web applications to store session-state data to a distributed cache system.

Namespace:   Microsoft.ApplicationServer.Caching
Assembly:  Microsoft.ApplicationServer.Caching.Client (in Microsoft.ApplicationServer.Caching.Client.dll)

Inheritance Hierarchy

System.Object
  System.Configuration.Provider.ProviderBase
    System.Web.SessionState.SessionStateStoreProviderBase
      Microsoft.ApplicationServer.Caching.DataCacheSessionStoreProvider

Syntax

[ObsoleteAttribute("This type is obsolete and will be removed in a future release. Please use Microsoft.Web.DistributedCache.DistributedCacheSessionStateStoreProvider in assembly Microsoft.Web.DistributedCache.dll instead", 
    false)]
public sealed class DataCacheSessionStoreProvider : SessionStateStoreProviderBase
[ObsoleteAttribute("This type is obsolete and will be removed in a future release. Please use Microsoft.Web.DistributedCache.DistributedCacheSessionStateStoreProvider in assembly Microsoft.Web.DistributedCache.dll instead", 
    false)]
public ref class DataCacheSessionStoreProvider sealed : SessionStateStoreProviderBase
[<Sealed>]
[<ObsoleteAttribute("This type is obsolete and will be removed in a future release. Please use Microsoft.Web.DistributedCache.DistributedCacheSessionStateStoreProvider in assembly Microsoft.Web.DistributedCache.dll instead",
    false)>]
type DataCacheSessionStoreProvider = 
    class
        inherit SessionStateStoreProviderBase
    end
<ObsoleteAttribute("This type is obsolete and will be removed in a future release. Please use Microsoft.Web.DistributedCache.DistributedCacheSessionStateStoreProvider in assembly Microsoft.Web.DistributedCache.dll instead",
    False)>
Public NotInheritable Class DataCacheSessionStoreProvider
    Inherits SessionStateStoreProviderBase

Constructors

Name Description
System_CAPS_pubmethod DataCacheSessionStoreProvider()

Initializes a new instance of the DataCacheSessionStoreProvider class.

Properties

Name Description
System_CAPS_pubproperty ApplicationName

The application name. This is used to differentiate sessions in the data source by application.

System_CAPS_pubproperty Description

(Inherited from ProviderBase.)

System_CAPS_pubproperty Name

(Inherited from ProviderBase.)

Methods

Name Description
System_CAPS_pubmethod CreateNewStoreData(HttpContext, Int32)

Creates a new data storage object for the current request.(Overrides SessionStateStoreProviderBase.CreateNewStoreData(HttpContext, Int32).)

System_CAPS_pubmethod CreateUninitializedItem(HttpContext, String, Int32)

Adds a new session state to the distributed cache. (Overrides SessionStateStoreProviderBase.CreateUninitializedItem(HttpContext, String, Int32).)

System_CAPS_pubmethod Dispose()

Releases all resources used by the DataCacheSessionStoreProvider class.(Overrides SessionStateStoreProviderBase.Dispose().)

System_CAPS_pubmethod EndRequest(HttpContext)

Called by the SessionStateModule class at the end of a request(Overrides SessionStateStoreProviderBase.EndRequest(HttpContext).)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetItem(HttpContext, String, Boolean, TimeSpan, Object, SessionStateActions)

Returns read-only session-state data from the cache.(Overrides SessionStateStoreProviderBase.GetItem(HttpContext, String, Boolean, TimeSpan, Object, SessionStateActions).)

System_CAPS_pubmethod GetItemExclusive(HttpContext, String, Boolean, TimeSpan, Object, SessionStateActions)

Returns and locks the read-only session-state data from the cache.(Overrides SessionStateStoreProviderBase.GetItemExclusive(HttpContext, String, Boolean, TimeSpan, Object, SessionStateActions).)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod Initialize(String, NameValueCollection)

Initializes the distributed cache provider.(Overrides ProviderBase.Initialize(String, NameValueCollection).)

System_CAPS_pubmethod InitializeRequest(HttpContext)

Initializes the outgoing HTTP request.(Overrides SessionStateStoreProviderBase.InitializeRequest(HttpContext).)

System_CAPS_pubmethod ReleaseItemExclusive(HttpContext, String, Object)

Releases a lock on the session data in the cache.(Overrides SessionStateStoreProviderBase.ReleaseItemExclusive(HttpContext, String, Object).)

System_CAPS_pubmethod RemoveItem(HttpContext, String, Object, SessionStateStoreData)

Deletes session data from the cache.(Overrides SessionStateStoreProviderBase.RemoveItem(HttpContext, String, Object, SessionStateStoreData).)

System_CAPS_pubmethod ResetItemTimeout(HttpContext, String)

Updates the expiration date and time of session data in the cache.(Overrides SessionStateStoreProviderBase.ResetItemTimeout(HttpContext, String).)

System_CAPS_pubmethod SetAndReleaseItemExclusive(HttpContext, String, SessionStateStoreData, Object, Boolean)

Updates the session item information in the cache with values from the current request and clears the lock on the session item.(Overrides SessionStateStoreProviderBase.SetAndReleaseItemExclusive(HttpContext, String, SessionStateStoreData, Object, Boolean).)

System_CAPS_pubmethod SetItemExpireCallback(SessionStateItemExpireCallback)

Sets a reference to the SessionStateItemExpireCallback delegate for the Session_OnEnd event defined in the Global.asax file.(Overrides SessionStateStoreProviderBase.SetItemExpireCallback(SessionStateItemExpireCallback).)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Remarks

For more information, see the documentation for the base class SessionStateStoreProviderBase.

Thread Safety

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

See Also

Microsoft.ApplicationServer.Caching Namespace

Return to top