IHttpSessionState Interface

Definitie

Naamruimte:

System.Web.SessionState

Assembly:

System.Web.dll

Definieert het contract voor het implementeren van een aangepaste sessiestatuscontainer.

public interface class IHttpSessionState

public interface IHttpSessionState

type IHttpSessionState = interface

Public Interface IHttpSessionState

Afgeleid

System.Web.SessionState.HttpSessionStateContainer

Voorbeelden

In het volgende codevoorbeeld wordt de interface geïmplementeerd om een nieuwe sessiestatuscontainerklasse met de IHttpSessionState naam MySessionStatete maken.

using System;
using System.Web;
using System.Web.SessionState;
using System.Collections;
using System.Collections.Specialized;
using System.Text;
using System.Threading;
using System.Globalization;

namespace Samples.AspNet.SessionState
{
  public sealed class MySessionState : IHttpSessionState
  {
    const int MAX_TIMEOUT = 24 * 60;  // Timeout cannot exceed 24 hours.

    string                      pId;
    ISessionStateItemCollection pSessionItems;
    HttpStaticObjectsCollection pStaticObjects;
    int                         pTimeout;
    bool                        pNewSession;
    HttpCookieMode              pCookieMode;
    SessionStateMode            pMode;
    bool                        pAbandon;
    bool                        pIsReadonly;

    public MySessionState(string                      id, 
                          ISessionStateItemCollection sessionItems,
                          HttpStaticObjectsCollection staticObjects,
                          int                         timeout,
                          bool                        newSession,
                          HttpCookieMode              cookieMode,
                          SessionStateMode            mode,
                          bool                        isReadonly)
    {
      pId            = id;   
      pSessionItems  = sessionItems;
      pStaticObjects = staticObjects;
      pTimeout       = timeout;    
      pNewSession    = newSession; 
      pCookieMode    = cookieMode;
      pMode          = mode;
      pIsReadonly    = isReadonly;
    }

    public int Timeout
    {
      get { return pTimeout; }
      set
      {
        if (value <= 0)
          throw new ArgumentException("Timeout value must be greater than zero.");

        if (value > MAX_TIMEOUT)
          throw new ArgumentException("Timout cannot be greater than " + MAX_TIMEOUT.ToString());

        pTimeout = value;
      }
    }

    public string SessionID
    {
      get { return pId; }
    }

    public bool IsNewSession
    {
      get { return pNewSession; }
    }

    public SessionStateMode Mode
    {
      get { return pMode; }
    }

    public bool IsCookieless
    {
      get { return CookieMode == HttpCookieMode.UseUri; }
    }

    public HttpCookieMode CookieMode
    {
      get { return pCookieMode; }
    }

    //
    // Abandon marks the session as abandoned. The IsAbandoned property is used by the
    // session state module to perform the abandon work during the ReleaseRequestState event.
    //
    public void Abandon()
    {
      pAbandon = true;
    }

    public bool IsAbandoned
    {
      get { return pAbandon; }
    }

    //
    // Session.LCID exists only to support legacy ASP compatibility. ASP.NET developers should use
    // Page.LCID instead.
    //
    public int LCID
    {
      get { return Thread.CurrentThread.CurrentCulture.LCID; }
      set { Thread.CurrentThread.CurrentCulture = CultureInfo.ReadOnly(new CultureInfo(value)); }
    }

    //
    // Session.CodePage exists only to support legacy ASP compatibility. ASP.NET developers should use
    // Response.ContentEncoding instead.
    //
    public int CodePage
    {
      get
      { 
        if (HttpContext.Current != null)
          return HttpContext.Current.Response.ContentEncoding.CodePage;
        else
          return Encoding.Default.CodePage;
      }
      set
      { 
        if (HttpContext.Current != null)
          HttpContext.Current.Response.ContentEncoding = Encoding.GetEncoding(value);
      }
    }

    public HttpStaticObjectsCollection StaticObjects
    {
      get { return pStaticObjects; }
    }

    public object this[string name]
    {
      get { return pSessionItems[name]; }
      set { pSessionItems[name] = value; }
    }

    public object this[int index]
    {
      get { return pSessionItems[index]; }
      set { pSessionItems[index] = value; }
    }

    public void Add(string name, object value)
    {
      pSessionItems[name] = value;        
    }

    public void Remove(string name)
    {
      pSessionItems.Remove(name);
    }

    public void RemoveAt(int index)
    {
      pSessionItems.RemoveAt(index);
    }

    public void Clear()
    {
      pSessionItems.Clear();
    }

    public void RemoveAll()
    {
        Clear();
    }

    public int Count
    {
      get { return pSessionItems.Count; }
    }

    public NameObjectCollectionBase.KeysCollection Keys
    {
      get { return pSessionItems.Keys; }
    }

    public IEnumerator GetEnumerator()
    {
      return pSessionItems.GetEnumerator();
    }

    public void CopyTo(Array items, int index)
    {
      foreach (object o in items)
        items.SetValue(o, index++);
    }

    public object SyncRoot
    {
        get { return this; }
    }

    public bool IsReadOnly
    {
      get { return pIsReadonly; }
    }

    public bool IsSynchronized
    {
      get { return false; }
    }
  }
}

Imports System.Web
Imports System.Web.SessionState
Imports System.Collections
Imports System.Collections.Specialized
Imports System.Text
Imports System.Threading
Imports System.Globalization

Namespace Samples.AspNet.SessionState

  Public NotInheritable Class MySessionState
    Implements IHttpSessionState
  
    Const MAX_TIMEOUT As Integer = 24 * 60  ' Timeout cannot exceed 24 hours.

    Dim pId            As String
    Dim pSessionItems  As ISessionStateItemCollection
    Dim pStaticObjects As HttpStaticObjectsCollection
    Dim pTimeout       As Integer
    Dim pNewSession    As Boolean
    Dim pCookieMode    As HttpCookieMode
    Dim pMode          As SessionStateMode
    Dim pAbandon       As Boolean
    Dim pIsReadonly    As Boolean

    Public Sub New(id            As String, _
                   sessionItems  As ISessionStateItemCollection, _
                   staticObjects As HttpStaticObjectsCollection, _
                   timeout       As Integer, _
                   newSession    As Boolean, _
                   cookieMode    As HttpCookieMode, _
                   mode          As SessionStateMode, _  
                   isReadonly As Boolean)
    
      pId            = id   
      pSessionItems  = sessionItems
      pStaticObjects = staticObjects
      pTimeout       = timeout    
      pNewSession    = newSession 
      pCookieMode    = cookieMode
      pMode          = mode
      pIsReadonly    = isReadonly
    End Sub


    Public Property Timeout As Integer Implements IHttpSessionState.Timeout
      Get
        Return pTimeout
      End Get
      Set
        If value <= 0 Then _
          Throw New ArgumentException("Timeout value must be greater than zero.")

        If value > MAX_TIMEOUT Then _
          Throw New ArgumentException("Timout cannot be greater than " & MAX_TIMEOUT.ToString())

        pTimeout = value
      End Set
    End Property


    Public ReadOnly Property SessionID As String Implements IHttpSessionState.SessionID
      Get
        Return pId
      End Get
    End Property


    Public ReadOnly Property IsNewSession As Boolean Implements IHttpSessionState.IsNewSession
      Get
        Return pNewSession
      End Get
    End Property


    Public ReadOnly Property Mode As SessionStateMode Implements IHttpSessionState.Mode    
      Get
        Return pMode
      End Get
    End Property


    Public ReadOnly Property IsCookieless As Boolean Implements IHttpSessionState.IsCookieLess    
      Get
        Return CookieMode = HttpCookieMode.UseUri
      End Get
    End Property


    Public ReadOnly Property CookieMode As HttpCookieMode Implements IHttpSessionState.CookieMode    
      Get
        Return pCookieMode
      End Get
    End Property


    '
    ' Abandon marks the session as abandoned. The IsAbandoned property is used by the
    ' session state module to perform the abandon work during the ReleaseRequestState event.
    '
    Public Sub Abandon() Implements IHttpSessionState.Abandon
      pAbandon = True
    End Sub

    Public ReadOnly Property IsAbandoned As Boolean  
      Get
        Return pAbandon
      End Get
    End Property

    '
        ' Session.LCID exists only to support legacy ASP compatibility. ASP.NET developers should use
    ' Page.LCID instead.
    '
    Public Property LCID As Integer Implements IHttpSessionState.LCID
      Get
        Return Thread.CurrentThread.CurrentCulture.LCID
      End Get
      Set
        Thread.CurrentThread.CurrentCulture = CultureInfo.ReadOnly(new CultureInfo(value))
      End Set
    End Property


    '
        ' Session.CodePage exists only to support legacy ASP compatibility. ASP.NET developers should use
    ' Response.ContentEncoding instead.
    '
    Public Property CodePage As Integer Implements IHttpSessionState.CodePage    
      Get
        If Not HttpContext.Current Is Nothing Then
          Return HttpContext.Current.Response.ContentEncoding.CodePage
        Else
          Return Encoding.Default.CodePage
        End If
      End Get
      Set       
        If Not HttpContext.Current Is Nothing Then _
          HttpContext.Current.Response.ContentEncoding = Encoding.GetEncoding(value)
      End Set
    End Property


    Public ReadOnly Property StaticObjects As HttpStaticObjectsCollection _
      Implements IHttpSessionState.StaticObjects
    
      Get
        Return pStaticObjects
      End Get
    End Property


    Public Property Item(name As String) As Object Implements IHttpSessionState.Item
      Get
        Return pSessionItems(name)
      End Get
      Set
        pSessionItems(name) = value
      End Set
    End Property


    Public Property Item(index As Integer) As Object Implements IHttpSessionState.Item    
      Get
        Return pSessionItems(index)
      End Get
      Set
        pSessionItems(index) = value
      End Set
    End Property
        

    Public Sub Add(name As String, value As Object) Implements IHttpSessionState.Add    
      pSessionItems(name) = value        
    End Sub


    Public Sub Remove(name As String) Implements IHttpSessionState.Remove    
      pSessionItems.Remove(name)
    End Sub


    Public Sub RemoveAt(index As Integer) Implements IHttpSessionState.RemoveAt    
      pSessionItems.RemoveAt(index)
    End Sub


    Public Sub Clear() Implements IHttpSessionState.Clear 
      pSessionItems.Clear()
    End Sub

    Public Sub RemoveAll() Implements IHttpSessionState.RemoveAll
        Clear()
    End Sub



    Public ReadOnly Property Count As Integer Implements IHttpSessionState.Count    
      Get
        Return pSessionItems.Count
      End Get
    End Property



    Public ReadOnly Property Keys As NameObjectCollectionBase.KeysCollection _
      Implements IHttpSessionState.Keys
    
      Get
        Return pSessionItems.Keys
      End Get
    End Property


    Public Function GetEnumerator() As IEnumerator Implements IHttpSessionState.GetEnumerator
        Return pSessionItems.GetEnumerator()
    End Function


    Public Sub CopyTo(items As Array, index As Integer) Implements IHttpSessionState.CopyTo    
      For Each o As Object In items
        items.SetValue(o, index)
        index += 1
      Next
    End Sub


    Public ReadOnly Property SyncRoot As Object Implements IHttpSessionState.SyncRoot    
        Get
          Return Me
       End Get
    End Property


    Public ReadOnly Property IsReadOnly As Boolean Implements IHttpSessionState.IsReadOnly    
      Get
        Return pIsReadonly
      End Get
    End Property


    Public ReadOnly Property IsSynchronized As Boolean Implements IHttpSessionState.IsSynchronized    
      Get
        Return False
      End Get
    End Property
  End Class
End Namespace

Opmerkingen

Een sessiestatuscontainer biedt toegang tot de sessiestatuswaarden en gerelateerde informatie voor de huidige sessie. Sessiegegevens die zijn opgenomen in een sessiestatuscontainer, worden via de HttpSessionState klasse beschikbaar gemaakt voor toepassingscode met behulp van de Session eigenschap. De HttpSessionState klasse is een wrapper-klasse voor een sessiestatuscontainer.

De ASP.NET-implementatie van een sessiestatuscontainer is de klasse HttpSessionStateContainer. Aan het begin van een aanvraag, tijdens de AcquireRequestState gebeurtenis, SessionStateModule wordt een HttpSessionStateContainer object gemaakt en ingevuld en aan het huidige HttpContextobject toegewezen. Aan het einde van een aanvraag, tijdens de ReleaseRequestState gebeurtenis, SessionStateModule wordt het HttpSessionStateContainer object opgehaald uit de huidige HttpContext en worden alle vereiste sessiewerkzaamheden uitgevoerd, zoals het schrijven van de sessiewaarden naar het sessiearchief of het afbreken van de sessie. Als de aanvraag plotseling wordt beëindigd, bijvoorbeeld via een omleiding, SessionStateModule wordt dezelfde opschoonactie uitgevoerd door de methode aan te EndRequest roepen.

Als u een aangepaste sessiestatuscontainer wilt maken, maakt u een klasse die de IHttpSessionState interface implementeert. Als u uw eigen aangepaste sessiestatuscontainer maakt, moet u ook de SessionStateModule container vervangen door uw eigen aangepaste module. Uw aangepaste module maakt een exemplaar van uw aangepaste sessiestatuscontainer en voegt deze toe aan de huidige HttpContext met behulp van de AddHttpSessionStateToContext methode. Een voorbeeld van een aangepaste module sessiestatus is opgenomen in het SessionStateUtility klasseoverzicht.

Eigenschappen

Name	Description
CodePage	Hiermee haalt u de codepagina-id voor de huidige sessie op of stelt u deze in.
CookieMode	Hiermee wordt een waarde opgehaald die aangeeft of de toepassing is geconfigureerd voor sessies zonder cookies.
Count	Hiermee haalt u het aantal items op in de verzameling sessiestatusitems.
IsCookieless	Hiermee wordt een waarde opgehaald die aangeeft of de sessie-id is ingesloten in de URL of is opgeslagen in een HTTP-cookie.
IsNewSession	Hiermee wordt een waarde opgehaald die aangeeft of de sessie is gemaakt met de huidige aanvraag.
IsReadOnly	Hiermee wordt een waarde opgehaald die aangeeft of de sessie alleen-lezen is.
IsSynchronized	Hiermee wordt een waarde opgehaald die aangeeft of de toegang tot de verzameling sessiestatuswaarden wordt gesynchroniseerd (thread safe).
Item[Int32]	Hiermee wordt een sessiestatusitemwaarde opgehaald of ingesteld op numerieke index.
Item[String]	Hiermee haalt u een sessiestatusitemwaarde op naam op of stelt u deze in.
Keys	Hiermee haalt u een verzameling sleutels op voor alle waarden die zijn opgeslagen in de verzameling sessiestatusitems.
LCID	Hiermee haalt u de landinstellings-id (LCID) van de huidige sessie op of stelt u deze in.
Mode	Hiermee haalt u de huidige sessiestatusmodus op.
SessionID	Hiermee haalt u de unieke sessie-id voor de sessie op.
StaticObjects	Hiermee haalt u een verzameling objecten op die zijn gedeclareerd door <object Runat="Server" Scope="Session"/> tags in het ASP.NET toepassingsbestand Global.asax.
SyncRoot	Hiermee haalt u een object op dat kan worden gebruikt om de toegang tot de verzameling sessiestatuswaarden te synchroniseren.
Timeout	Hiermee haalt u de time-outperiode (in minuten) op die is toegestaan tussen aanvragen voordat de sessiestatusprovider de sessie beëindigt.

Methoden

Name	Description
Abandon()	Hiermee wordt de huidige sessie beëindigd.
Add(String, Object)	Hiermee voegt u een nieuw item toe aan de verzameling sessiestatus.
Clear()	Hiermee wist u alle waarden uit de verzameling sessiestatusitems.
CopyTo(Array, Int32)	Kopieert de verzameling sessiestatusitemwaarden naar een eendimensionale matrix, te beginnen bij de opgegeven index in de matrix.
GetEnumerator()	Retourneert een enumerator die kan worden gebruikt om alle waarden voor sessiestatusitems in de huidige sessie te lezen.
Remove(String)	Hiermee verwijdert u een item uit de verzameling sessiestatusitems.
RemoveAll()	Hiermee wist u alle waarden uit de verzameling sessiestatusitems.
RemoveAt(Int32)	Hiermee verwijdert u een item in een opgegeven index uit de verzameling sessiestatusitems.

Zie ook

• Overzicht van ASP.NET sessiestatus