ChunkedCookieHandler ChunkedCookieHandler ChunkedCookieHandler ChunkedCookieHandler Class

Definition

Represents a cookie handler that writes cookie data so that cookies never exceed a set size.

public ref class ChunkedCookieHandler sealed : System::IdentityModel::Services::CookieHandler
public sealed class ChunkedCookieHandler : System.IdentityModel.Services.CookieHandler
type ChunkedCookieHandler = class
    inherit CookieHandler
Public NotInheritable Class ChunkedCookieHandler
Inherits CookieHandler
Inheritance
ChunkedCookieHandlerChunkedCookieHandlerChunkedCookieHandlerChunkedCookieHandler

Remarks

The ChunkedCookieHandler class presents the cookie as a logical entity, so that, in the case of cookies with a size that exceeds a specified threshold (the chunk size), a single call to the Write method breaks the data into a series of actual client-side cookies, none of which exceeds the chunk size.

Cookie names are constructed based on the name parameter to the Write, Read, or Delete methods. The cookie names are constructed by appending a number to the base name: name, name1, name2, and so on.

Constructors

ChunkedCookieHandler() ChunkedCookieHandler() ChunkedCookieHandler() ChunkedCookieHandler()

Initializes a new instance of the ChunkedCookieHandler class that uses the default chunk size.

ChunkedCookieHandler(Int32) ChunkedCookieHandler(Int32) ChunkedCookieHandler(Int32) ChunkedCookieHandler(Int32)

Initializes a new instance of the ChunkedCookieHandler class that uses a specified chunk size.

Fields

DefaultChunkSize DefaultChunkSize DefaultChunkSize DefaultChunkSize

The default chunk size of 2000 characters.

MinimumChunkSize MinimumChunkSize MinimumChunkSize MinimumChunkSize

The minimum chunk size of 1000 characters.

Properties

ChunkSize ChunkSize ChunkSize ChunkSize

Gets the chunk size used by the current instance.

Domain Domain Domain Domain

Gets or sets the domain used for cookies.

(Inherited from CookieHandler)
HideFromClientScript HideFromClientScript HideFromClientScript HideFromClientScript

Gets or sets a value that indicates whether the cookie should be hidden from client script.

(Inherited from CookieHandler)
Name Name Name Name

Gets or sets the base name for cookies written by the handler.

(Inherited from CookieHandler)
Path Path Path Path

Gets or sets the virtual path for cookies written by the handler.

(Inherited from CookieHandler)
PersistentSessionLifetime PersistentSessionLifetime PersistentSessionLifetime PersistentSessionLifetime

The lifetime of persistent sessions. If zero, transient sessions are always used.

(Inherited from CookieHandler)
RequireSsl RequireSsl RequireSsl RequireSsl

Gets or sets a value that specifies whether the cookie should be used only with SSL.

(Inherited from CookieHandler)

Methods

Delete() Delete() Delete() Delete()

Deletes the cookie associated with the current request that has the default name, domain, and path.

(Inherited from CookieHandler)
Delete(HttpContext) Delete(HttpContext) Delete(HttpContext) Delete(HttpContext)

Deletes the cookie associated with the current request that has the default name, domain, and path.

(Inherited from CookieHandler)
Delete(String) Delete(String) Delete(String) Delete(String)

Deletes the cookie associated with the current request that has the specified name and the default domain and path.

(Inherited from CookieHandler)
Delete(String, HttpContext) Delete(String, HttpContext) Delete(String, HttpContext) Delete(String, HttpContext)

Deletes the cookie associated with the specified request that has the specified name and the default domain and path.

(Inherited from CookieHandler)
Delete(String, String, String, HttpContext) Delete(String, String, String, HttpContext) Delete(String, String, String, HttpContext) Delete(String, String, String, HttpContext)

Deletes the cookie associated with the specified request that has the specified name, path, and domain.

(Inherited from CookieHandler)
DeleteCore(String, String, String, HttpContext) DeleteCore(String, String, String, HttpContext) DeleteCore(String, String, String, HttpContext) DeleteCore(String, String, String, HttpContext)

When overridden in a derived class, deletes the cookie associated with the specified request that has the specified name, domain, and path.

(Inherited from CookieHandler)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MatchCookiePath(Uri, Uri) MatchCookiePath(Uri, Uri) MatchCookiePath(Uri, Uri) MatchCookiePath(Uri, Uri)

If the target domain is within the cookie domain and the target path is within the cookie path, match the casing of the cookie path portion.

(Inherited from CookieHandler)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Read() Read() Read() Read()

Reads the cookie associated with the current request that has the default name.

(Inherited from CookieHandler)
Read(HttpContext) Read(HttpContext) Read(HttpContext) Read(HttpContext)

Reads the cookie associated with the current request that has the default name, domain, and path.

(Inherited from CookieHandler)
Read(String) Read(String) Read(String) Read(String)

Reads the cookie associated with the current request that has the specified name.

(Inherited from CookieHandler)
Read(String, HttpContext) Read(String, HttpContext) Read(String, HttpContext) Read(String, HttpContext)

Reads the cookie associated with the specified request that has the specified name and the default domain and path.

(Inherited from CookieHandler)
ReadCore(String, HttpContext) ReadCore(String, HttpContext) ReadCore(String, HttpContext) ReadCore(String, HttpContext)

When overridden in a derived class, reads the cookie that has the specified name and that is associated with the specified request.

(Inherited from CookieHandler)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
Write(Byte[], Boolean, DateTime) Write(Byte[], Boolean, DateTime) Write(Byte[], Boolean, DateTime) Write(Byte[], Boolean, DateTime)

Writes a cookie associated with the current request that has the specified value, persistence, and expiration time.

(Inherited from CookieHandler)
Write(Byte[], String, DateTime) Write(Byte[], String, DateTime) Write(Byte[], String, DateTime) Write(Byte[], String, DateTime)

Writes a cookie associated with the current request that has the specified name, value, and expiration time.

(Inherited from CookieHandler)
Write(Byte[], String, DateTime, HttpContext) Write(Byte[], String, DateTime, HttpContext) Write(Byte[], String, DateTime, HttpContext) Write(Byte[], String, DateTime, HttpContext)

Writes a cookie associated with the specified request that has the specified name, value, and expiration time.

(Inherited from CookieHandler)
Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext) Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext) Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext) Write(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)

Writes a cookie associated with the specified request that has the specified name, value, domain, path, expiration time, and visibility.

(Inherited from CookieHandler)
WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext) WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext) WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext) WriteCore(Byte[], String, String, String, DateTime, Boolean, Boolean, HttpContext)

When overridden in a derived class, writes a cookie associated with the specified request that has the specified name, value, domain, path, expiration time, persistence and visibility.

(Inherited from CookieHandler)

Applies to