Skip to content

class ChunkingCookieManager

cangjie
public class ChunkingCookieManager <: ICookieManager

功能:提供支持分块写入的 Cookie 管理器。

父类型:

成员概览

成员功能
init()创建一个分块 Cookie 管理器。
var chunkSize指定单个 Cookie 分块的最大长度。
var throwForPartialCookies指定遇到缺失分块时是否抛出异常。
func getRequestCookie(HttpContext, String)从请求中读取指定 Cookie 值。
func appendResponseCookie(HttpContext, String, ?String, CookieOptions)向响应写入指定 Cookie 值。
func deleteCookie(HttpContext, String, CookieOptions)从响应中删除指定 Cookie。

init()

cangjie
public init()

功能:创建一个分块 Cookie 管理器。

var chunkSize

cangjie
public var chunkSize: ?Int64 = DefaultChunkSize

功能:指定单个 Cookie 分块的最大长度。

类型:?Int64

var throwForPartialCookies

cangjie
public var throwForPartialCookies: Bool = false

功能:指定遇到缺失分块时是否抛出异常。

类型:Bool

func getRequestCookie(HttpContext, String)

cangjie
public func getRequestCookie(context: HttpContext, key: String): ?String

功能:从请求中读取指定 Cookie 值。

参数:

  • context: HttpContext - 当前 HTTP 上下文。
  • key: String - Cookie 名称。

返回值:

  • ?String - Cookie 值;不存在时返回 None。

异常:

  • IllegalFormatException - 当分块 Cookie 不完整且启用严格检查时抛出。

func appendResponseCookie(HttpContext, String, ?String, CookieOptions)

cangjie
public func appendResponseCookie(context: HttpContext, key: String, value: ?String, options: CookieOptions): Unit

功能:向响应写入指定 Cookie 值。

参数:

  • context: HttpContext - 当前 HTTP 上下文。
  • key: String - Cookie 名称。
  • value: ?String - Cookie 值。
  • options: CookieOptions - Cookie 选项。

返回值:

  • Unit

异常:

  • UnsupportedException - 当分块大小不足以容纳数据时抛出。

func deleteCookie(HttpContext, String, CookieOptions)

cangjie
public func deleteCookie(context: HttpContext, key: String, options: CookieOptions): Unit

功能:从响应中删除指定 Cookie。

参数:

返回值:

  • Unit