rfc9111

package

v0.14.0 Latest Latest Go to latest Published: Nov 10, 2025 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/2manymws/rc

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CalclateExpires(d *ResponseDirectives, resHeader http.Header, heuristicExpirationRatio float64, ...) time.Time
type ExtendedRule
type RequestDirectives
- func ParseRequestCacheControlHeader(headers []string) *RequestDirectives
type ResponseDirectives
- func ParseResponseCacheControlHeader(headers []string) *ResponseDirectives
type Shared
- func NewShared(opts ...SharedOption) (*Shared, error)
- func (s *Shared) Handle(req *http.Request, cachedReq *http.Request, cachedRes *http.Response, ...) (useCached bool, r *http.Response, _ error)
- func (s *Shared) Storable(req *http.Request, res *http.Response, now time.Time) (bool, time.Time)
type SharedOption

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNegativeRatio = errors.New("invalid heuristic expiration ratio (< 0)")

Functions ¶

func CalclateExpires ¶

func CalclateExpires(d *ResponseDirectives, resHeader http.Header, heuristicExpirationRatio float64, now time.Time) time.Time

Types ¶

type ExtendedRule ¶ added in v0.7.0

type ExtendedRule interface {
	// Cacheable returns true and and the expiration time if the response is cacheable.
	Cacheable(req *http.Request, res *http.Response) (ok bool, age time.Duration)
}

ExtendedRule is an extended rule. Like proxy_cache_valid of NGINX. Rules are applied only when there is no Cache-Control header and the expiration time cannot be calculated. THIS IS NOT RFC 9111.

type RequestDirectives ¶

type RequestDirectives struct {
	// max-age https://www.rfc-editor.org/rfc/rfc9111#section-5.2.1.1
	MaxAge *uint32
	// max-stale https://www.rfc-editor.org/rfc/rfc9111#section-5.2.1.2
	MaxStale *uint32
	// min-fresh https://www.rfc-editor.org/rfc/rfc9111#section-5.2.1.3
	MinFresh *uint32
	// no-cache https://www.rfc-editor.org/rfc/rfc9111#section-5.2.1.4
	NoCache bool
	// no-store https://www.rfc-editor.org/rfc/rfc9111#section-5.2.1.5
	NoStore bool
	// no-transform https://www.rfc-editor.org/rfc/rfc9111#section-5.2.1.6
	NoTransform bool
	// only-if-cached https://www.rfc-editor.org/rfc/rfc9111#section-5.2.1.7
	OnlyIfCached bool
}

func ParseRequestCacheControlHeader ¶

func ParseRequestCacheControlHeader(headers []string) *RequestDirectives

ParseRequestCacheControlHeader parses the Cache-Control header of a request.

type ResponseDirectives ¶

type ResponseDirectives struct {
	// max-age https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.1
	MaxAge *uint32
	// must-revalidate https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.2
	MustRevalidate bool
	// must-understand https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.3
	MustUnderstand bool
	// no-cache https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.4
	NoCache bool
	// no-store https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.5
	NoStore bool
	// no-transform https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.6
	NoTransform bool
	// private https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.7
	Private bool
	// proxy-revalidate https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.8
	ProxyRevalidate bool
	// public https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.9
	Public bool
	// s-maxag https://www.rfc-editor.org/rfc/rfc9111#section-5.2.2.10
	SMaxAge *uint32
	// stale-while-revalidate https://www.rfc-editor.org/rfc/rfc9111#section-4.2.4 https://www.rfc-editor.org/rfc/rfc5861
	StaleWhileRevalidate *uint32
	// stale-if-error https://www.rfc-editor.org/rfc/rfc9111#section-4.2.4 https://www.rfc-editor.org/rfc/rfc5861
	StaleIfError *uint32
}

func ParseResponseCacheControlHeader ¶

func ParseResponseCacheControlHeader(headers []string) *ResponseDirectives

ParseResponseCacheControlHeader parses the Cache-Control header of a response.

type Shared ¶

type Shared struct {
	// contains filtered or unexported fields
}

Shared is a shared cache that implements RFC 9111. The following features are not implemented - Private cache. - Request directives.

func NewShared ¶

func NewShared(opts ...SharedOption) (*Shared, error)

NewShared returns a new Shared cache handler.

func (*Shared) Handle ¶

func (s *Shared) Handle(req *http.Request, cachedReq *http.Request, cachedRes *http.Response, do func(*http.Request) (*http.Response, error), now time.Time) (useCached bool, r *http.Response, _ error)

func (*Shared) Storable ¶

func (s *Shared) Storable(req *http.Request, res *http.Response, now time.Time) (bool, time.Time)

Storable returns true if the response is storable in the cache.

type SharedOption ¶

type SharedOption func(*Shared) error

SharedOption is an option for Shared.

func ExtendedRules ¶ added in v0.7.0

func ExtendedRules(rules []ExtendedRule) SharedOption

ExtendedRules sets the extended rules.

func HeuristicExpirationRatio ¶

func HeuristicExpirationRatio(ratio float64) SharedOption

HeuristicExpirationRatio sets the heuristic expiration ratio.

func HeuristicallyCacheableStatusCodes ¶

func HeuristicallyCacheableStatusCodes(statusCodes []int) SharedOption

HeuristicallyCacheableStatusCodes sets the heuristically cacheable status codes.

func StoreRequestWithSetCookieHeader ¶ added in v0.7.0

func StoreRequestWithSetCookieHeader() SharedOption

StoreRequestWithSetCookieHeader enables storing request with Set-Cookie header.

func UnderstoodMethods ¶

func UnderstoodMethods(methods []string) SharedOption

UnderstoodMethods sets the understood methods.

func UnderstoodStatusCodes ¶

func UnderstoodStatusCodes(statusCodes []int) SharedOption

UnderstoodStatusCodes sets the understood status codes.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL