httpcache

README

httpcache

http RoundTripper providing persistent and volatile cache

go get github.com/StalkR/httpcache

Bugs, comments, questions: create a new issue or email httpcache@stalkr.net.

Documentation

Overview

Package httpcache implements net/http RoundTripper with caching. Persistent with a cache using files. Volatile with a cache in memory.

The following rules applies for caching:

• only responses of GET requests are cached (no POST, etc.)
• only body response is cached (no headers)
• only response status 200 (OK) and response status 301 (Moved Permanently)

Index

• func NewPersistent(transport http.RoundTripper, path string, TTL time.Duration) http.RoundTripper
• func NewPersistentClient(path string, TTL time.Duration) (*http.Client, error)
• func NewVolatile(transport http.RoundTripper, TTL time.Duration, maxItems int) http.RoundTripper
• func NewVolatileClient(TTL time.Duration, maxItems int) *http.Client
• type Cache
• type CachedRoundTrip
  • func (c *CachedRoundTrip) RoundTrip(req *http.Request) (*http.Response, error)

Functions

func NewPersistent

func NewPersistent(transport http.RoundTripper, path string, TTL time.Duration) http.RoundTripper

NewPersistent creates an http RoundTripper with a file cache. Cache files will be created under path.

func NewPersistentClient

func NewPersistentClient(path string, TTL time.Duration) (*http.Client, error)

NewPersistentClient creates an http client with a file cache.

func NewVolatile

func NewVolatile(transport http.RoundTripper, TTL time.Duration, maxItems int) http.RoundTripper

NewVolatile creates an http RoundTripper with a memory cache.

func NewVolatileClient

func NewVolatileClient(TTL time.Duration, maxItems int) *http.Client

NewVolatileClient creates an http client with a memory cache.

Types

type Cache

type Cache interface {
	Get(u *url.URL) (*entry, error)
	Put(u *url.URL, data []byte) error
}

Cache represents the ability to cache response data from URL.

type CachedRoundTrip

type CachedRoundTrip struct {
	Transport http.RoundTripper
	Cache     Cache
	TTL       time.Duration
}

A CachedRoundTrip implements net/http RoundTripper with a cache.

func (*CachedRoundTrip) RoundTrip

func (c *CachedRoundTrip) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip loads from cache if possible or RoundTrips and saves it.