WebMethodAttribute.EnableSession Tulajdonság

Definíció

Azt jelzi, hogy engedélyezve van-e a munkamenet állapota egy XML-webszolgáltatás-metódushoz.

public:
 property bool EnableSession { bool get(); void set(bool value); };
public bool EnableSession { get; set; }
member this.EnableSession : bool with get, set
Public Property EnableSession As Boolean

Tulajdonság értéke

true ha a munkamenet állapota engedélyezve van egy XML-webszolgáltatás-metódushoz. Az alapértelmezett érték a false.

Példák

Az alábbi példa munkamenet-állapottal határozza meg, hogy egy adott munkamenet hányszor fér hozzá az XML Web Service metódushoz SessionHitCounter.

<%@ WebService Language="C#" Class="Util" %>
 
 using System.Web.Services;
 
 public class Util: WebService {
   [ WebMethod(Description="Per session Hit Counter",EnableSession=true)]
    public int SessionHitCounter() {
       if (Session["HitCounter"] == null) {
          Session["HitCounter"] = 1;
       }
       else {
          Session["HitCounter"] = ((int) Session["HitCounter"]) + 1;
          }
       return ((int) Session["HitCounter"]);
    }   
 }
<%@ WebService Language="VB" Class="Util" %>
 
Imports System.Web.Services

Public Class Util
    Inherits WebService
    
    <WebMethod(Description := "Per session Hit Counter", _
        EnableSession := True)> _
    Public Function SessionHitCounter() As Integer
        
        If Session("HitCounter") Is Nothing Then
            Session("HitCounter") = 1
        Else
            Session("HitCounter") = CInt(Session("HitCounter")) + 1
        End If
        Return CInt(Session("HitCounter"))
    End Function
End Class

Az alábbi példakód egy munkamenet-állapotot használó XML-webszolgáltatás Web Forms-ügyfele. Az ügyfél megőrzi azt a HTTP-cookie-t, amely egyedileg azonosítja a munkamenetet úgy, hogy az ügyfél munkamenet-állapotában tárolja.

<%@ Page Language="C#" %>
<%@ Import Namespace="System.IO" %>
<%@ Import Namespace="System.Net" %>

<html>

    <script runat="server">

        void EnterBtn_Click(Object Src, EventArgs E) 
    {
      // Create a new instance of a proxy class for your XML Web service.
      ServerUsage su = new ServerUsage();
          CookieContainer cookieJar;

      // Check to see if the cookies have already been saved for this session.
      if (Session["CookieJar"] == null) 
        cookieJar= new CookieContainer();
          else
       cookieJar = (CookieContainer) Session["CookieJar"];

        // Assign the CookieContainer to the proxy class.
        su.CookieContainer = cookieJar;

      // Invoke an XML Web service method that uses session state and thus cookies.
      int count = su.PerSessionServiceUsage();         

      // Store the cookies received in the session state for future retrieval by this session.
      Session["CookieJar"] = cookieJar;

          // Populate the text box with the results from the call to the XML Web service method.
          SessionCount.Text = count.ToString();  
        }
         
    </script>
    <body>
       <form runat=server ID="Form1">
           
             Click to bump up the Session Counter.
             <p>
             <asp:button text="Bump Up Counter" Onclick="EnterBtn_Click" runat=server ID="Button1" NAME="Button1"/>
             <p>
             <asp:label id="SessionCount"  runat=server/>
          
       </form>
    </body>
</html>
<%@ Page Language="VB" %>
<%@ Import Namespace="System.IO" %>
<%@ Import Namespace="System.Net" %>

<html>

    <script runat=server>

        Public Sub EnterBtn_Click(src As Object, E As EventArgs) 

      ' Create a new instance of a proxy class for your XML Web service.
      Dim su As ServerUsage = new ServerUsage()
          Dim cookieJar As CookieContainer

      ' Check to see if the cookies have already been saved for this session.
      If (Session("CookieJar") Is Nothing) 
        cookieJar= new CookieContainer()
          Else
       cookieJar = Session("CookieJar")
      End If
   

        ' Assign the CookieContainer to the proxy class.
        su.CookieContainer = cookieJar

      ' Invoke an XML Web service method that uses session state and thus cookies.
      Dim count As Integer = su.PerSessionServiceUsage()         

      ' Store the cookies received in the session state for future retrieval by this session.
      Session("CookieJar") = cookieJar

          ' Populate the text box with the results from the call to the XML Web service method.
          SessionCount.Text = count.ToString()  
    End Sub
         
    </script>
    <body>
       <form runat=server ID="Form1">
           
             Click to bump up the Session Counter.
             <p>
             <asp:button text="Bump Up Counter" Onclick="EnterBtn_Click" runat=server ID="Button1" NAME="Button1"/>
             <p>
             <asp:label id="SessionCount"  runat=server/>
          
       </form>
    </body>
</html>

Megjegyzések

Ahhoz, hogy a munkamenet állapota a ASP.NET HttpSessionState objektumban legyen tárolva, az XML-webszolgáltatásnak örökölnie kell WebService és egy WebMethodAttribute xml webszolgáltatás-metódusra alkalmazott EnableSession tulajdonságot true értékre. Ha egy XML-webszolgáltatás-metódushoz nincs szükség munkamenetállapotra, a letiltás javíthatja a teljesítményt.

Az XML-webszolgáltatás-ügyfelet egy XML-webszolgáltatás által visszaadott HTTP-cookie azonosítja egyedileg. Ahhoz, hogy egy XML-webszolgáltatás megőrizze az ügyfél munkamenet-állapotát, az ügyfélnek meg kell őriznie a cookie-t. Az ügyfelek az XML Web service metódus meghívása CookieContainer előtt új példány létrehozásával és a CookieContainer proxyosztály tulajdonságához való hozzárendelésével megkaphatják a HTTP-cookie-t. Ha a proxyosztály-példány hatókörén kívülre kell tartania a munkamenet állapotát, az ügyfélnek meg kell őriznie a HTTP-cookie-t az XML-webszolgáltatás felé irányuló hívások között. Egy Web Forms-ügyfél például a saját munkamenet-állapotában mentve megőrizheti a CookieContainer HTTP-cookie-t. Mivel nem minden XML-webszolgáltatás használ munkamenet-állapotot, ezért az ügyfeleknek nem mindig kell használniuk az CookieContainer ügyfélproxy tulajdonságát, az XML-webszolgáltatás dokumentációjának meg kell állapítania, hogy a munkamenet állapota használatban van-e.

A következőre érvényes:

Lásd még