cache

Documentation

Index

• Constants
• func Middleware(h http.Handler) http.Handler
• func SetHint(ctx context.Context, scope Scope, maxAge time.Duration)
• func WithCacheControlExtension(ctx context.Context) context.Context
• type CacheControlExtension
  • func CacheControl(ctx context.Context) *CacheControlExtension
  • func (cache *CacheControlExtension) AddHint(h Hint)
  • func (cache *CacheControlExtension) OverallPolicy() OverallCachePolicy
• type Extension
  • func (c Extension) ExtensionName() string
  • func (c Extension) InterceptResponse(ctx context.Context, next graphql.ResponseHandler) *graphql.Response
  • func (c Extension) Validate(_ graphql.ExecutableSchema) error
• type Hint
• type OverallCachePolicy
  • func GetOverallCachePolicy(cache *CacheControlExtension) (OverallCachePolicy, bool)
• type Scope

Constants

const (
	ScopePublic  = Scope("PUBLIC")
	ScopePrivate = Scope("PRIVATE")
)

Functions

func Middleware

func Middleware(h http.Handler) http.Handler

Middleware returns an instance of cachedServer.

func SetHint

func SetHint(ctx context.Context, scope Scope, maxAge time.Duration)

func WithCacheControlExtension

func WithCacheControlExtension(ctx context.Context) context.Context

Types

type CacheControlExtension

type CacheControlExtension struct {
	Version int    `json:"version"`
	Hints   []Hint `json:"hints"`
	// contains filtered or unexported fields
}

func CacheControl

func CacheControl(ctx context.Context) *CacheControlExtension

func (*CacheControlExtension) AddHint

func (cache *CacheControlExtension) AddHint(h Hint)

func (*CacheControlExtension) OverallPolicy

func (cache *CacheControlExtension) OverallPolicy() OverallCachePolicy

OverallPolicy return a calculated cache policy

type Extension

type Extension struct{}

func (Extension) ExtensionName

func (c Extension) ExtensionName() string

func (Extension) InterceptResponse

func (c Extension) InterceptResponse(ctx context.Context, next graphql.ResponseHandler) *graphql.Response

func (Extension) Validate

func (c Extension) Validate(_ graphql.ExecutableSchema) error

type Hint

type Hint struct {
	Path   ast.Path `json:"path"`
	MaxAge float64  `json:"maxAge"`
	Scope  Scope    `json:"scope"`
}

type OverallCachePolicy

type OverallCachePolicy struct {
	MaxAge float64
	Scope  Scope
}

func GetOverallCachePolicy

func GetOverallCachePolicy(cache *CacheControlExtension) (OverallCachePolicy, bool)

GetOverallCachePolicy is responsible to extract cache policy from a Response. If does not have any cacheControl in Extensions, it will return (empty, false)

type Scope

type Scope string