client

Documentation

Overview

Package client provides an http client used extensively by Takeout for syncing media. There's support for local file-based caching and cache-only usage.

Index

• Constants
• Variables
• func Get(path string) ([]byte, error)
• type Config
  • func (c *Config) Merge(o Config)
• type Getter
  • func NewCacheOnlyGetter(config Config) Getter
  • func NewDefaultGetter() Getter
  • func NewGetter(config Config) Getter
  • func NewTransportGetter(config Config, transport http.RoundTripper) Getter
• type RateLimiter

Constants

const (
	DirectiveMaxAge       = "max-age"
	DirectiveOnlyIfCached = "only-if-cached"
)

Variables

var (
	ErrCacheMiss          = errors.New("cache miss")
	ErrSchemeNotSupported = errors.New("scheme not supported")
)

Functions

func Get

func Get(path string) ([]byte, error)

Types

type Config

type Config struct {
	UserAgent string
	CacheDir  string
	MaxAge    time.Duration
}

func (*Config) Merge

func (c *Config) Merge(o Config)

type Getter

type Getter interface {
	Get(url string) (http.Header, []byte, error)
	GetBody(url string) ([]byte, error)
	GetJson(url string, result interface{}) error
	GetJsonWith(headers map[string]string, url string, result interface{}) error
	GetXML(url string, result interface{}) error
	GetPLS(url string) (pls.Playlist, error)
}

func NewCacheOnlyGetter

func NewCacheOnlyGetter(config Config) Getter

func NewDefaultGetter

func NewDefaultGetter() Getter

func NewGetter

func NewGetter(config Config) Getter

func NewTransportGetter

func NewTransportGetter(config Config, transport http.RoundTripper) Getter

type RateLimiter

type RateLimiter interface {
	RateLimit(host string)
}

var DefaultLimiter RateLimiter = &timeLimiter{}

var UnlimitedLimiter RateLimiter = unlimitedLimiter(0)