ChunkedCookieHandler Class

.NET Framework (current version)
 

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

Namespace:   System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

System.Object
  System.IdentityModel.Services.CookieHandler
    System.IdentityModel.Services.ChunkedCookieHandler

Public NotInheritable Class ChunkedCookieHandler
	Inherits CookieHandler

NameDescription
System_CAPS_pubmethodChunkedCookieHandler()

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

System_CAPS_pubmethodChunkedCookieHandler(Int32)

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

NameDescription
System_CAPS_pubpropertyChunkSize

Gets the chunk size used by the current instance.

System_CAPS_pubpropertyDomain

Gets or sets the domain used for cookies.(Inherited from CookieHandler.)

System_CAPS_pubpropertyHideFromClientScript

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

System_CAPS_pubpropertyName

Gets or sets the base name for cookies written by the handler.(Inherited from CookieHandler.)

System_CAPS_pubpropertyPath

Gets or sets the virtual path for cookies written by the handler.(Inherited from CookieHandler.)

System_CAPS_pubpropertyPersistentSessionLifetime

The lifetime of persistent sessions. If zero, transient sessions are always used.(Inherited from CookieHandler.)

System_CAPS_pubpropertyRequireSsl

Gets or sets a value that specifies whether the cookie should be used only with SSL.(Inherited from CookieHandler.)

NameDescription
System_CAPS_pubmethodDelete()

Deletes the cookie associated with the current request that has the default name, domain, and path.(Inherited from CookieHandler.)

System_CAPS_pubmethodDelete(HttpContext)

Deletes the cookie associated with the current request that has the default name, domain, and path.(Inherited from CookieHandler.)

System_CAPS_pubmethodDelete(String)

Deletes the cookie associated with the current request that has the specified name and the default domain and path. (Inherited from CookieHandler.)

System_CAPS_pubmethodDelete(String, HttpContext)

Deletes the cookie associated with the specified request that has the specified name and the default domain and path.(Inherited from CookieHandler.)

System_CAPS_pubmethodDelete(String, String, String, HttpContext)

Deletes the cookie associated with the specified request that has the specified name, path, and domain. (Inherited from CookieHandler.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodMatchCookiePath(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.)

System_CAPS_pubmethodRead()

Reads the cookie associated with the current request that has the default name.(Inherited from CookieHandler.)

System_CAPS_pubmethodRead(HttpContext)

Reads the cookie associated with the current request that has the default name, domain, and path.(Inherited from CookieHandler.)

System_CAPS_pubmethodRead(String)

Reads the cookie associated with the current request that has the specified name. (Inherited from CookieHandler.)

System_CAPS_pubmethodRead(String, HttpContext)

Reads the cookie associated with the specified request that has the specified name and the default domain and path. (Inherited from CookieHandler.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodWrite(Byte(), Boolean, DateTime)

Writes a cookie associated with the current request that has the specified value, persistence, and expiration time.(Inherited from CookieHandler.)

System_CAPS_pubmethodWrite(Byte(), String, DateTime)

Writes a cookie associated with the current request that has the specified name, value, and expiration time.(Inherited from CookieHandler.)

System_CAPS_pubmethodWrite(Byte(), String, DateTime, HttpContext)

Writes a cookie associated with the specified request that has the specified name, value, and expiration time.(Inherited from CookieHandler.)

System_CAPS_pubmethodWrite(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.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticDefaultChunkSize

The default chunk size of 2000 characters.

System_CAPS_pubfieldSystem_CAPS_staticMinimumChunkSize

The minimum chunk size of 1000 characters.

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.

.NET Framework
Available since 4.5

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: