Documentation
¶
Index ¶
- Constants
- Variables
- type Locker
- type Mutex
- type Pool
- type Redis
- type RedisKey
- type RedisKeyer
- type RedisStore
- func (c *RedisStore) Delete(key ...interface{}) (err error)
- func (c *RedisStore) Expire(key string, timeout uint) (err error)
- func (c *RedisStore) Flush() (err error)
- func (c *RedisStore) Get(key string) (result []byte, err error)
- func (c *RedisStore) HGet(key string, value string) (result []byte, err error)
- func (c *RedisStore) HMSet(key string, value string, result []byte) (err error)
- func (c *RedisStore) Incr(key string) (result int, err error)
- func (c *RedisStore) Lock(key string) error
- func (c *RedisStore) Set(key string, result []byte) (err error)
- func (c *RedisStore) SetEx(key string, timeout uint, result []byte) (err error)
- func (c *RedisStore) Unlock(key string) bool
- type RedisStorer
Constants ¶
View Source
const ( // DefaultExpiry is used when Mutex Duration is 0 DefaultExpiry = 6 * time.Second // DefaultTries is used when Mutex Duration is 0 DefaultTries = 16 // DefaultDelay is used when Mutex Delay is 0 DefaultDelay = 512 * time.Millisecond // DefaultFactor is used when Mutex Factor is 0 DefaultFactor = 0.01 )
Variables ¶
View Source
var ( RedisKeyIndex = make(map[string]RedisKey) RedisKeys = []RedisKey{ {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, {/* contains filtered or unexported fields */}, } )
View Source
var ( // ErrFailed is returned when lock cannot be acquired ErrFailed = errors.New("failed to acquire lock") )
Functions ¶
This section is empty.
Types ¶
type Mutex ¶
type Mutex struct {
Expiry time.Duration // Duration for which the lock is valid, DefaultExpiry if 0
Tries int // Number of attempts to acquire lock before admitting failure, DefaultTries if 0
Delay time.Duration // Delay between two attempts to acquire lock, DefaultDelay if 0
Factor float64 // Drift factor, DefaultFactor if 0
Quorum int // Quorum for the lock, set to len(addrs)/2+1 by NewMutex()
// contains filtered or unexported fields
}
A Mutex is a mutual exclusion lock.
type Redis ¶
type RedisKey ¶
type RedisKey struct {
// contains filtered or unexported fields
}
type RedisKeyer ¶
type RedisStore ¶
RedisStore holds a handle to the Redis pool
var ( RedisCache RedisStore ErrCacheMiss = errors.New("cache: key not found.") )
func (*RedisStore) Delete ¶
func (c *RedisStore) Delete(key ...interface{}) (err error)
Delete will delete a key
func (*RedisStore) Expire ¶
func (c *RedisStore) Expire(key string, timeout uint) (err error)
will set expire on a redis key
func (*RedisStore) Flush ¶
func (c *RedisStore) Flush() (err error)
Flush will call flushall and delete all keys
func (*RedisStore) Get ¶
func (c *RedisStore) Get(key string) (result []byte, err error)
Get will retrieve a key
func (*RedisStore) HGet ¶
func (c *RedisStore) HGet(key string, value string) (result []byte, err error)
HGet will retrieve a hash
func (*RedisStore) HMSet ¶
func (c *RedisStore) HMSet(key string, value string, result []byte) (err error)
HMSet will set a hash
func (*RedisStore) Incr ¶
func (c *RedisStore) Incr(key string) (result int, err error)
will increment a redis key
func (*RedisStore) Set ¶
func (c *RedisStore) Set(key string, result []byte) (err error)
Set will set a single record
type RedisStorer ¶
type RedisStorer interface {
Lock(key string) error
Unlock(key string) bool
Get(key string) (result []byte, err error)
HGet(key string, value string) (result []byte, err error)
Set(key string, result []byte) (err error)
SetEx(key string, timeout uint, result []byte) (err error)
HMSet(key string, value string, result []byte) (err error)
Delete(key ...interface{}) (err error)
Flush() (err error)
Incr(key string) (result int, err error)
Expire(key string, timeout uint) (err error)
}
Click to show internal directories.
Click to hide internal directories.