IHttpSessionState Interfész

Definíció

Névtér:

System.Web.SessionState

Szerelvény:

System.Web.dll

Meghatározza az egyéni munkamenet-állapot tárolójának implementálására vonatkozó szerződést.

public interface class IHttpSessionState

public interface IHttpSessionState

type IHttpSessionState = interface

Public Interface IHttpSessionState

Származtatott

System.Web.SessionState.HttpSessionStateContainer

Példák

Az alábbi kódpéldában implementálja a IHttpSessionState felületet egy új, munkamenet-állapotú tárolóosztály létrehozásához MySessionState.

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

Megjegyzések

A munkamenet-állapot tárolója hozzáférést biztosít az aktuális munkamenet munkamenetállapot-értékeihez és kapcsolódó információihoz. A munkamenet-állapot tárolójában található munkamenet-információk az osztályon keresztül, a tulajdonság használatával válnak elérhetővé az HttpSessionStateSession alkalmazáskód számára. Az HttpSessionState osztály egy munkamenet-állapot tároló burkolóosztálya.

A munkamenet-állapot tárolójának ASP.NET implementációja a HttpSessionStateContainer osztály. A kérés elején, az AcquireRequestState esemény során a SessionStateModule rendszer létrehoz és feltölt egy HttpSessionStateContainer objektumot, és hozzárendeli az aktuálishoz HttpContext. A kérés végén, az esemény során a ReleaseRequestStateSessionStateModule rendszer lekéri az objektumot az HttpSessionStateContainer aktuálisból HttpContext , és végrehajtja a szükséges munkamenet-műveleteket, például a munkamenet értékeinek írását a munkamenet-tárolóba, vagy megszakítja a munkamenetet. Ha a kérés hirtelen leáll, például átirányítással, a SessionStateModule metódus meghívásával EndRequest ugyanezt a törlést hajtja végre.

Egyéni munkamenet-állapot tároló létrehozásához hozzon létre egy osztályt, amely implementálja a IHttpSessionState felületet. Ha saját egyéni munkamenet-állapottárolót hoz létre, a SessionStateModule saját egyéni modulját is le kell cserélnie. Az egyéni modul létrehozza az egyéni munkamenet-állapot tárolójának egy példányát, és hozzáadja az aktuálishoz HttpContext a AddHttpSessionStateToContext metódus használatával. Az osztály áttekintése egy egyéni munkamenet-állapot modulra SessionStateUtility mutat be példát.

Tulajdonságok

Name	Description
CodePage	Lekéri vagy beállítja az aktuális munkamenet kódlap-azonosítóját.
CookieMode	Olyan értéket kap, amely jelzi, hogy az alkalmazás konfigurálva van-e cookie nélküli munkamenetekhez.
Count	Lekéri a munkamenet-állapot elemgyűjteményében lévő elemek számát.
IsCookieless	Beolvas egy értéket, amely jelzi, hogy a munkamenet-azonosító beágyazva van-e az URL-címbe, vagy EGY HTTP-cookie-ban van-e tárolva.
IsNewSession	Beolvas egy értéket, amely jelzi, hogy a munkamenet az aktuális kéréssel lett-e létrehozva.
IsReadOnly	Beolvas egy értéket, amely jelzi, hogy a munkamenet írásvédett-e.
IsSynchronized	Beolvas egy értéket, amely jelzi, hogy a munkamenet-állapot értékeinek gyűjteményéhez való hozzáférés szinkronizálva van-e (a szál biztonságos).
Item[Int32]	Beolvas vagy beállít egy munkamenet-állapot elemértéket numerikus index alapján.
Item[String]	Lekéri vagy beállítja a munkamenet-állapot elemértékét név szerint.
Keys	Lekéri a munkamenet-állapot elemgyűjteményében tárolt összes érték kulcsainak gyűjteményét.
LCID	Lekéri vagy beállítja az aktuális munkamenet területi azonosítóját (LCID).
Mode	Lekéri az aktuális munkamenet-állapot módot.
SessionID	Lekéri a munkamenet egyedi munkamenet-azonosítót.
StaticObjects	Lekéri <object Runat="Server" Scope="Session"/> címkék által deklarált objektumok gyűjteményét a Global.asax ASP.NET alkalmazásfájlban.
SyncRoot	Lekéri a munkamenet-állapot értékeinek gyűjteményéhez való hozzáférés szinkronizálására használható objektumot.
Timeout	Lekéri vagy beállítja a kérések között engedélyezett időtúllépési időtartamot (percben), mielőtt a munkamenet-állapot szolgáltatója leállítja a munkamenetet.

Metódusok

Name	Description
Abandon()	Befejezi az aktuális munkamenetet.
Add(String, Object)	Új elemet ad hozzá a munkamenet-állapot gyűjteményéhez.
Clear()	Törli az összes értéket a munkamenet-állapotelem-gyűjteményből.
CopyTo(Array, Int32)	A munkamenet-állapot elemértékeinek gyűjteményét egy egydimenziós tömbbe másolja, a tömb megadott indexétől kezdve.
GetEnumerator()	Egy enumerátort ad vissza, amely az aktuális munkamenet összes munkamenet-állapotelem-értékének olvasására használható.
Remove(String)	Töröl egy elemet a munkamenet-állapot elemgyűjteményéből.
RemoveAll()	Törli az összes értéket a munkamenet-állapotelem-gyűjteményből.
RemoveAt(Int32)	Egy adott indexben lévő elemet töröl a munkamenet-állapot elemgyűjteményéből.

Lásd még

• ASP.NET munkamenetállapot áttekintése