HTTPHeaders.CacheControl

Topics

Structures

• struct MaxStale
  The max-stale option can be present with no value, or be present with a number of seconds. By using a struct you can check the nullability of the maxStale variable as well as then check the nullability of the seconds to differentiate.

Initializers

• init(mustRevalidated: Bool, noCache: Bool, noStore: Bool, noTransform: Bool, isPublic: Bool, isPrivate: Bool, proxyRevalidate: Bool, onlyIfCached: Bool, immutable: Bool, maxAge: Int?, sMaxAge: Int?, maxStale: HTTPHeaders.CacheControl.MaxStale?, minFresh: Int?, staleWhileRevalidate: Int?, staleIfError: Int?)
  Creates a new CacheControl.

Instance Properties

• var immutable: Bool
  Indicates that the response body will not change over time.
• var isPrivate: Bool
  The response is for a single user and must not be stored by a shared cache. A private cache (like the user’s browser cache) may store the response.
• var isPublic: Bool
  The response may be cached by any cache, even if the response is normally non-cacheable
• var maxAge: Int?
  The maximum amount of time a resource is considered fresh. Unlike theExpires header, this directive is relative to the time of the request.
• var maxStale: HTTPHeaders.CacheControl.MaxStale?
  Indicates the client will accept a stale response. An optional value in seconds indicates the upper limit of staleness the client will accept.
• var minFresh: Int?
  Indicates the client wants a response that will still be fresh for at least the specified number of seconds.
• var mustRevalidate: Bool
  Indicates that once a resource becomes stale, caches must not use their stale copy without successful validation on the origin server.
• var noCache: Bool
  Caches must check with the origin server for validation before using the cached copy.
• var noStore: Bool
  The cache should not store anything about the client request or server response.
• var noTransform: Bool
  No transformations or conversions should be made to the resource. The Content-Encoding, Content-Range, Content-Type headers must not be modified by a proxy. A non-transparent proxy or browser feature such as Google’s Light Mode might, for example, convert between image formats in order to save cache space or to reduce the amount of traffic on a slow link. The no-transform directive disallows this.
• var onlyIfCached: Bool
  Indicates to not retrieve new data. This being the case, the server wishes the client to obtain a response only once and then cache. From this moment the client should keep releasing a cached copy and avoid contacting the origin-server to see if a newer copy exists.
• var proxyRevalidate: Bool
  Like must-revalidate, but only for shared caches (e.g., proxies). Ignored by private caches.
• var sMaxAge: Int?
  Overrides max-age or the Expires header, but only for shared caches (e.g., proxies). Ignored by private caches.
• var staleIfError: Int?
  Indicates the client will accept a stale response if the check for a fresh one fails. The value indicates how many seconds long the client will accept the stale response after the initial expiration.
• var staleWhileRevalidate: Int?
  Indicates the client will accept a stale response, while asynchronously checking in the background for a fresh one. The value indicates how long the client will accept a stale response.

Instance Methods

• func serialize() -> String
  Generates the header string for this instance.

Type Methods

• static func parse(String) -> HTTPHeaders.CacheControl?