Documentation
¶
Index ¶
- Constants
- Variables
- type CacheStore
- type InMemoryStore
- func (c *InMemoryStore) Add(key string, value any, expires time.Duration) error
- func (c *InMemoryStore) Decrement(key string, n uint64) (uint64, error)
- func (c *InMemoryStore) Delete(key string) error
- func (c *InMemoryStore) Flush() error
- func (c *InMemoryStore) Get(key string, value any) error
- func (c *InMemoryStore) Increment(key string, n uint64) (uint64, error)
- func (c *InMemoryStore) Replace(key string, value any, expires time.Duration) error
- func (c *InMemoryStore) Set(key string, value any, expires time.Duration) error
- type MemcachedBinaryStore
- func (s *MemcachedBinaryStore) Add(key string, value any, expires time.Duration) error
- func (s *MemcachedBinaryStore) Decrement(key string, delta uint64) (uint64, error)
- func (s *MemcachedBinaryStore) Delete(key string) error
- func (s *MemcachedBinaryStore) Flush() error
- func (s *MemcachedBinaryStore) Get(key string, value any) error
- func (s *MemcachedBinaryStore) Increment(key string, delta uint64) (uint64, error)
- func (s *MemcachedBinaryStore) Replace(key string, value any, expires time.Duration) error
- func (s *MemcachedBinaryStore) Set(key string, value any, expires time.Duration) error
- type MemcachedStore
- func (c *MemcachedStore) Add(key string, value any, expires time.Duration) error
- func (c *MemcachedStore) Decrement(key string, delta uint64) (uint64, error)
- func (c *MemcachedStore) Delete(key string) error
- func (c *MemcachedStore) Flush() error
- func (c *MemcachedStore) Get(key string, value any) error
- func (c *MemcachedStore) Increment(key string, delta uint64) (uint64, error)
- func (c *MemcachedStore) Replace(key string, value any, expires time.Duration) error
- func (c *MemcachedStore) Set(key string, value any, expires time.Duration) error
- type RedisStore
- func (c *RedisStore) Add(key string, value any, expires time.Duration) error
- func (c *RedisStore) Decrement(key string, delta uint64) (newValue uint64, err error)
- func (c *RedisStore) Delete(key string) error
- func (c *RedisStore) Flush() error
- func (c *RedisStore) Get(key string, ptrValue any) error
- func (c *RedisStore) Increment(key string, delta uint64) (uint64, error)
- func (c *RedisStore) Replace(key string, value any, expires time.Duration) error
- func (c *RedisStore) Set(key string, value any, expires time.Duration) error
Constants ¶
const ( DEFAULT = time.Duration(0) FOREVER = time.Duration(-1) )
Variables ¶
Functions ¶
This section is empty.
Types ¶
type CacheStore ¶
type CacheStore interface {
// Get retrieves an item from the cache. Returns the item or nil, and a bool indicating
// whether the key was found.
Get(key string, value any) error
// Set sets an item to the cache, replacing any existing item.
Set(key string, value any, expire time.Duration) error
// Add adds an item to the cache only if an item doesn't already exist for the given
// key, or if the existing item has expired. Returns an error otherwise.
Add(key string, value any, expire time.Duration) error
// Replace sets a new value for the cache key only if it already exists. Returns an
// error if it does not.
Replace(key string, data any, expire time.Duration) error
// Delete removes an item from the cache. Does nothing if the key is not in the cache.
Delete(key string) error
// Increment increments a real number, and returns error if the value is not real
Increment(key string, data uint64) (uint64, error)
// Decrement decrements a real number, and returns error if the value is not real
Decrement(key string, data uint64) (uint64, error)
// Flush deletes all items from the cache.
Flush() error
}
CacheStore is the interface of a cache backend
type InMemoryStore ¶
InMemoryStore represents the cache with memory persistence
func NewInMemoryStore ¶
func NewInMemoryStore(defaultExpiration time.Duration) *InMemoryStore
NewInMemoryStore returns a InMemoryStore
func (*InMemoryStore) Decrement ¶
func (c *InMemoryStore) Decrement(key string, n uint64) (uint64, error)
Decrement (see CacheStore interface)
func (*InMemoryStore) Delete ¶
func (c *InMemoryStore) Delete(key string) error
Delete (see CacheStore interface)
func (*InMemoryStore) Flush ¶
func (c *InMemoryStore) Flush() error
Flush (see CacheStore interface)
func (*InMemoryStore) Get ¶
func (c *InMemoryStore) Get(key string, value any) error
Get (see CacheStore interface)
func (*InMemoryStore) Increment ¶
func (c *InMemoryStore) Increment(key string, n uint64) (uint64, error)
Increment (see CacheStore interface)
type MemcachedBinaryStore ¶
MemcachedBinaryStore represents the cache with memcached persistence using the binary protocol
func NewMemcachedBinaryStore ¶
func NewMemcachedBinaryStore(hostList, username, password string, defaultExpiration time.Duration) *MemcachedBinaryStore
NewMemcachedBinaryStore returns a MemcachedBinaryStore
func NewMemcachedBinaryStoreWithConfig ¶
func NewMemcachedBinaryStoreWithConfig(hostList, username, password string, defaultExpiration time.Duration, config *mc.Config) *MemcachedBinaryStore
NewMemcachedBinaryStoreWithConfig returns a MemcachedBinaryStore using the provided configuration
func (*MemcachedBinaryStore) Decrement ¶
func (s *MemcachedBinaryStore) Decrement(key string, delta uint64) (uint64, error)
Decrement (see CacheStore interface)
func (*MemcachedBinaryStore) Delete ¶
func (s *MemcachedBinaryStore) Delete(key string) error
Delete (see CacheStore interface)
func (*MemcachedBinaryStore) Flush ¶
func (s *MemcachedBinaryStore) Flush() error
Flush (see CacheStore interface)
func (*MemcachedBinaryStore) Get ¶
func (s *MemcachedBinaryStore) Get(key string, value any) error
Get (see CacheStore interface)
func (*MemcachedBinaryStore) Increment ¶
func (s *MemcachedBinaryStore) Increment(key string, delta uint64) (uint64, error)
Increment (see CacheStore interface)
type MemcachedStore ¶
MemcachedStore represents the cache with memcached persistence
func NewMemcachedStore ¶
func NewMemcachedStore(hostList []string, defaultExpiration time.Duration) *MemcachedStore
NewMemcachedStore returns a MemcachedStore
func (*MemcachedStore) Decrement ¶
func (c *MemcachedStore) Decrement(key string, delta uint64) (uint64, error)
Decrement (see CacheStore interface)
func (*MemcachedStore) Delete ¶
func (c *MemcachedStore) Delete(key string) error
Delete (see CacheStore interface)
func (*MemcachedStore) Flush ¶
func (c *MemcachedStore) Flush() error
Flush (see CacheStore interface)
func (*MemcachedStore) Get ¶
func (c *MemcachedStore) Get(key string, value any) error
Get (see CacheStore interface)
func (*MemcachedStore) Increment ¶
func (c *MemcachedStore) Increment(key string, delta uint64) (uint64, error)
Increment (see CacheStore interface)
type RedisStore ¶
type RedisStore struct {
// contains filtered or unexported fields
}
RedisStore represents the cache with redis persistence
func NewRedisCache ¶
func NewRedisCache(host string, password string, defaultExpiration time.Duration) *RedisStore
NewRedisCache returns a RedisStore until redigo supports sharding/clustering, only one host will be in hostList
func NewRedisCacheWithPool ¶
func NewRedisCacheWithPool(pool *redis.Pool, defaultExpiration time.Duration) *RedisStore
NewRedisCacheWithPool returns a RedisStore using the provided pool until redigo supports sharding/clustering, only one host will be in hostList
func NewRedisCacheWithURL ¶ added in v1.4.0
func NewRedisCacheWithURL(url string, defaultExpiration time.Duration) *RedisStore
NewRedisCacheWithURL returns a RedisStore using a redis URL and DialURL
func (*RedisStore) Decrement ¶
func (c *RedisStore) Decrement(key string, delta uint64) (newValue uint64, err error)
Decrement (see CacheStore interface)
func (*RedisStore) Delete ¶
func (c *RedisStore) Delete(key string) error
Delete (see CacheStore interface)
func (*RedisStore) Get ¶
func (c *RedisStore) Get(key string, ptrValue any) error
Get (see CacheStore interface)
func (*RedisStore) Increment ¶
func (c *RedisStore) Increment(key string, delta uint64) (uint64, error)
Increment (see CacheStore interface)