HttpListenerResponse.Cookies Property (System.Net)

.NET Framework Class Library

HttpListenerResponse..::.Cookies Property

Gets or sets the collection of cookies returned with the response.

Namespace: System.Net
Assembly: System (in System.dll)

Public Property Cookies As CookieCollection

public CookieCollection Cookies { get; set; }

public:
property CookieCollection^ Cookies {
	CookieCollection^ get ();
	void set (CookieCollection^ value);
}

member Cookies : CookieCollection with get, set

Property Value

Type: System.Net..::.CookieCollection
A CookieCollection that contains cookies to accompany the response. The collection is empty if no cookies have been added to the response.

Remarks

A cookie is name/value text data from a Web server that is stored on the local (client) computer. The following cookie formats are supported: Netscape, RFC 2109, and RFC 2965. The Netscape cookie specification is available at http://wp.netscape.com/newsref/std/cookie_spec.html; the RFC documents are available at http://www.rfc-editor.org.

Examples

The following code example checks a request for a cookie, and returns a new cookie with the response if the request did not have one.


' This example requires the System and System.Net namespaces.

Public Shared Function NextCustomerID() As String
    ' A real-world application would do something more robust
    ' to ensure uniqueness.
    Return Date.Now.ToString()
End Function
Public Shared Sub SimpleListenerCookieExample(ByVal prefixes() As String)
    ' Create a listener.
    Dim listener As New HttpListener()
    ' Add the prefixes.
    For Each s As String In prefixes
        listener.Prefixes.Add(s)
    Next s
    listener.IgnoreWriteExceptions = True
    listener.Start()
    Console.WriteLine("Listening...")
    ' Note: The GetContext method blocks while waiting for a request. 
    Dim context As HttpListenerContext = listener.GetContext()
    Dim request As HttpListenerRequest = context.Request
    Dim customerID As String = Nothing

    ' Did the request come with a cookie?
    Dim cookie As Cookie = request.Cookies("ID")
    If cookie IsNot Nothing Then
        customerID = cookie.Value
    End If
    If customerID IsNot Nothing Then
        Console.WriteLine("Found the cookie!")
    End If
    ' Get the response object.
    Dim response As HttpListenerResponse = context.Response
    ' If they didn't provide a cookie containing their ID, give them one.
    If customerID Is Nothing Then
        customerID = NextCustomerID()
        Dim cook As New Cookie("ID", customerID)
        response.AppendCookie(cook)
    End If
    ' Construct a response.
    Dim responseString As String = "<HTML><BODY> Hello " & customerID & "!</BODY></HTML>"
    Dim buffer() As Byte = System.Text.Encoding.UTF8.GetBytes(responseString)
    ' Get the response stream and write the response to it.
    response.ContentLength64 = buffer.Length
    Dim output As System.IO.Stream = response.OutputStream
    output.Write(buffer, 0, buffer.Length)
    ' You must close the output stream.
    output.Close()
    ' Closing the response sends the response to the client.
    response.Close()
    listener.Stop()
End Sub


// This example requires the System and System.Net namespaces.

public static string NextCustomerID()
{
    // A real-world application would do something more robust
    // to ensure uniqueness.
    return DateTime.Now.ToString();
}
public static void SimpleListenerCookieExample(string[] prefixes)
{
    // Create a listener.
    HttpListener listener = new HttpListener();
    // Add the prefixes.
    foreach (string s in prefixes)
    {
        listener.Prefixes.Add(s);
    }
    listener.IgnoreWriteExceptions = true;
    listener.Start();
    Console.WriteLine("Listening...");
    // Note: The GetContext method blocks while waiting for a request. 
    HttpListenerContext context = listener.GetContext();
    HttpListenerRequest request = context.Request;
    string customerID = null;

    // Did the request come with a cookie?
    Cookie cookie = request.Cookies["ID"];
    if (cookie != null)
    {
         customerID=cookie.Value;
    }
    if (customerID !=null)
    {
          Console.WriteLine("Found the cookie!");
    }
    // Get the response object.
    HttpListenerResponse response = context.Response;
    // If they didn't provide a cookie containing their ID, give them one.
    if (customerID == null)
    {
        customerID = NextCustomerID();
        Cookie cook = new Cookie("ID", customerID );
        response.AppendCookie (cook);
    }
    // Construct a response.
    string responseString = "<HTML><BODY> Hello " + customerID + "!</BODY></HTML>";
    byte[] buffer = System.Text.Encoding.UTF8.GetBytes(responseString);
    // Get the response stream and write the response to it.
    response.ContentLength64 = buffer.Length;
    System.IO.Stream output = response.OutputStream;
    output.Write(buffer,0,buffer.Length);
    // You must close the output stream.
    output.Close();
    // Closing the response sends the response to the client.
    response.Close();
    listener.Stop();
}

Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Platforms

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.

Reference

HttpListenerResponse Class