plugin_simplecache_conteo

package module

v1.0.8 Latest Latest Go to latest Published: Jul 1, 2022 License: Apache-2.0 Imports: 13 Imported by: 0

Details

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

Repository

github.com/igoooor/plugin-simplecache-conteo

Links

Open Source Insights

README ¶

Simple Cache

This is a fork from https://github.com/traefik/plugin-simplecache

Simple cache plugin middleware caches responses on disk.

Configuration

To configure this plugin you should add its configuration to the Traefik dynamic configuration as explained here. The following snippet shows how to configure this plugin with the File provider in TOML and YAML:

Static:

[pilot]
  token="xxx"

[experimental.plugins.cache]
  modulename = "github.com/igoooor/plugin-simplecache-conteo"
  version = "v0.0.1"

Dynamic:

[http.middlewares]
  [http.middlewares.my-cache.plugin.cache]
    path = "/some/path/to/cache/dir"

http:
  middlewares:
   my-cache:
      plugin:
        cache:
          path: /some/path/to/cache/dir

Options

Path (`path`)

The base path that files will be created under. This must be a valid existing filesystem path.

Max Expiry (`maxExpiry`)

Default: 300

The maximum number of seconds a response can be cached for. The actual cache time will always be lower or equal to this.

Cleanup (`cleanup`)

Default: 600

The number of seconds to wait between cache cleanup runs.

Add Status Header (`addStatusHeader`)

Default: true

This determines if the cache status header Cache-Status will be added to the response headers. This header can have the value hit, miss or error.

Documentation ¶

Overview ¶

Package plugin_simplecache_conteo is a plugin to cache responses to disk.

Index ¶

func New(_ context.Context, next http.Handler, cfg *Config, name string) (http.Handler, error)
type CacheSystem
type Config
- func CreateConfig() *Config
type KeyContext

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(_ context.Context, next http.Handler, cfg *Config, name string) (http.Handler, error)

New returns a plugin instance.

Types ¶

type CacheSystem ¶ added in v1.0.2

type CacheSystem interface {
	Get(string) ([]byte, error)
	DeleteAll(string)
	Delete(string)
	Set(string, []byte, time.Duration) error
	Close()
	Check(bool) bool
}

type Config ¶

type Config struct {
	Path            string     `json:"path" yaml:"path" toml:"path"`
	MaxExpiry       int        `json:"maxExpiry" yaml:"maxExpiry" toml:"maxExpiry"`
	Cleanup         int        `json:"cleanup" yaml:"cleanup" toml:"cleanup"`
	Memory          bool       `json:"memory" yaml:"memory" toml:"memory"`
	AddStatusHeader bool       `json:"addStatusHeader" yaml:"addStatusHeader" toml:"addStatusHeader"`
	FlushHeader     string     `json:"flushHeader" yaml:"flushHeader" toml:"flushHeader"`
	NextGenFormats  []string   `json:"nextGenFormats" yaml:"nextGenFormats" toml:"nextGenFormats"`
	Headers         []string   `json:"headers" yaml:"headers" toml:"headers"`
	Key             KeyContext `json:"key" yaml:"key" toml:"key"`
	Debug           bool       `json:"debug" yaml:"debug" toml:"debug"`
}

Config configures the middleware.

func CreateConfig ¶

func CreateConfig() *Config

CreateConfig returns a config instance.

type KeyContext ¶ added in v0.0.7

type KeyContext struct {
	DisableHost   bool `json:"disableHost" yaml:"disableHost" toml:"disableHost"`
	DisableMethod bool `json:"disableMethod" yaml:"disableMethod" toml:"disableMethod"`
}

Source Files ¶

View all Source files

cache.go

Directories ¶

Path	Synopsis
provider
api Package plugin_simplecache_conteo is a plugin to cache responses to disk.	Package plugin_simplecache_conteo is a plugin to cache responses to disk.
local Package plugin_simplecache_conteo is a plugin to cache responses to disk.	Package plugin_simplecache_conteo is a plugin to cache responses to disk.
test

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