Documentation
¶
Overview ¶
Package cache implements the types.Cache interface for storing and retrieving key/value pairs from a range of storage strategies.
Index ¶
- Constants
- Variables
- func Descriptions() string
- func New(conf Config, mgr types.Manager, log log.Modular, stats metrics.Type) (types.Cache, error)
- func NewMemcached(conf Config, mgr types.Manager, log log.Modular, stats metrics.Type) (types.Cache, error)
- func NewMemory(conf Config, mgr types.Manager, log log.Modular, stats metrics.Type) (types.Cache, error)
- func SanitiseConfig(conf Config) (interface{}, error)
- type Config
- type Memcached
- type MemcachedConfig
- type Memory
- type MemoryConfig
- type TypeSpec
Constants ¶
const ( TypeMemcached = "memcached" TypeMemory = "memory" )
String constants representing each cache type.
Variables ¶
var Constructors = map[string]TypeSpec{}
Constructors is a map of all cache types with their specs.
Functions ¶
func Descriptions ¶
func Descriptions() string
Descriptions returns a formatted string of descriptions for each type.
func New ¶
func New( conf Config, mgr types.Manager, log log.Modular, stats metrics.Type, ) (types.Cache, error)
New creates a cache type based on an cache configuration.
func NewMemcached ¶
func NewMemcached( conf Config, mgr types.Manager, log log.Modular, stats metrics.Type, ) (types.Cache, error)
NewMemcached returns a Memcached processor.
func NewMemory ¶
func NewMemory(conf Config, mgr types.Manager, log log.Modular, stats metrics.Type) (types.Cache, error)
NewMemory creates a new Memory cache type.
func SanitiseConfig ¶
SanitiseConfig creates a sanitised version of a config.
Types ¶
type Config ¶
type Config struct {
Type string `json:"type" yaml:"type"`
Memcached MemcachedConfig `json:"memcached" yaml:"memcached"`
Memory MemoryConfig `json:"memory" yaml:"memory"`
}
Config is the all encompassing configuration struct for all cache types.
func NewConfig ¶
func NewConfig() Config
NewConfig returns a configuration struct fully populated with default values.
func (*Config) UnmarshalJSON ¶
UnmarshalJSON ensures that when parsing configs that are in a map or slice the default values are still applied.
func (*Config) UnmarshalYAML ¶
UnmarshalYAML ensures that when parsing configs that are in a map or slice the default values are still applied.
type Memcached ¶
type Memcached struct {
// contains filtered or unexported fields
}
Memcached is a cache that connects to memcached servers.
func (*Memcached) Add ¶
Add attempts to set the value of a key only if the key does not already exist and returns an error if the key already exists or if the operation fails.
type MemcachedConfig ¶
type MemcachedConfig struct {
Addresses []string `json:"addresses" yaml:"addresses"`
Prefix string `json:"prefix" yaml:"prefix"`
TTL int32 `json:"ttl" yaml:"ttl"`
Retries int `json:"retries" yaml:"retries"`
RetryPeriodMS int `json:"retry_period_ms" yaml:"retry_period_ms"`
}
MemcachedConfig is a config struct for a memcached connection.
func NewMemcachedConfig ¶
func NewMemcachedConfig() MemcachedConfig
NewMemcachedConfig returns a MemcachedConfig with default values.
type Memory ¶
Memory is a memory based cache implementation.
func (*Memory) Add ¶
Add attempts to set the value of a key only if the key does not already exist and returns an error if the key already exists.
type MemoryConfig ¶
type MemoryConfig struct {
TTL int `json:"ttl" yaml:"ttl"`
CompactionIntervalS int `json:"compaction_interval_s" yaml:"compaction_interval_s"`
}
MemoryConfig contains config fields for the Memory cache type.
func NewMemoryConfig ¶
func NewMemoryConfig() MemoryConfig
NewMemoryConfig creates a MemoryConfig populated with default values.
Source Files