cachestatic

README

cachestatic

Cache Middleware for Golang

Documentation

Overview

Example

i := 0
h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
	fmt.Fprintf(w, "OK %d", i)
	i++
})

http.Handle("/", New(DefaultConfig)(h))
http.ListenAndServe(":8080", nil)

Index

• Variables
• func DefaultIndexer(r *http.Request) interface{}
• func New(c Config) func(http.Handler) http.Handler
• type Config
• type Indexer
  • func EncodingIndexer(encoding string) Indexer
• type SkipHeaderFunc
  • func SkipHeaders(headers ...string) SkipHeaderFunc

Examples

• Package

Variables

var DefaultConfig = Config{
	Skipper:     middleware.DefaultSkipper,
	Indexer:     DefaultIndexer,
	Invalidator: nil,
	SkipHeaders: SkipHeaders(header.SetCookie),
}

DefaultConfig is the default config

var InvalidateAll interface{} = invalidateAll{}

InvalidateAll invalidates all cache items

Functions

func DefaultIndexer

func DefaultIndexer(r *http.Request) interface{}

DefaultIndexer is the default indexer function

func New

func New(c Config) func(http.Handler) http.Handler

New creates new cachestatic middleware

Types

type Config

type Config struct {
	Skipper     middleware.Skipper
	Indexer     Indexer
	Invalidator chan interface{}
	SkipHeaders SkipHeaderFunc
}

Config type

type Indexer

type Indexer func(*http.Request) interface{}

Indexer is the function for map request to cache index

func EncodingIndexer

func EncodingIndexer(encoding string) Indexer

EncodingIndexer creates an indexer for adds encoding into index

type SkipHeaderFunc

type SkipHeaderFunc func(string) bool

SkipHeaderFunc is the function to skip header, return true to skip

func SkipHeaders

func SkipHeaders(headers ...string) SkipHeaderFunc

SkipHeaders skips all given headers