redlock

Documentation

Index

• Constants
• type KVCache
• type LockElem
• type RedClient
• type RedLock
  • func NewRedLock(addrs []string) (*RedLock, error)
  • func (r *RedLock) Lock(resource string, ttl int) (int64, error)
  • func (r *RedLock) SetRetryCount(count int)
  • func (r *RedLock) SetRetryDelay(delay int)
  • func (r *RedLock) UnLock(resource string) error
• type SimpleCache
  • func NewSimpleCache() *SimpleCache
  • func (sc *SimpleCache) Delete(key string)
  • func (sc *SimpleCache) GC()
  • func (sc *SimpleCache) Get(key string) *LockElem
  • func (sc *SimpleCache) Set(key, val string, expiry int64) *LockElem
  • func (sc *SimpleCache) Size() int

Constants

const (
	// DefaultRetryCount is the max retry times for lock acquire
	DefaultRetryCount = 10

	// DefaultRetryDelay is upper wait time in millisecond for lock acquire retry
	DefaultRetryDelay = 200

	// ClockDriftFactor is clock drift factor, more information refers to doc
	ClockDriftFactor = 0.01

	// UnlockScript is redis lua script to release a lock
	UnlockScript = `` /* 155-byte string literal not displayed */

)

Types

type KVCache

type KVCache interface {
	// Set sets the key value with its expiry in milliseconds
	Set(key, val string, expiry int64) *LockElem

	// Get queries LockElem from given key
	Get(key string) *LockElem

	// Delete removes the LockElem with given key from storage
	Delete(key string)

	// Size returns element count in kv storage
	Size() int

	// GC cleans the expired LockElem stored in storage
	GC()
}

KVCache defines interface for redlock key value storage

type LockElem

type LockElem struct {
	// contains filtered or unexported fields
}

LockElem keeps a lock element

type RedClient

type RedClient struct {
	// contains filtered or unexported fields
}

RedClient holds client to redis

type RedLock

type RedLock struct {
	// contains filtered or unexported fields
}

RedLock holds the redis lock

func NewRedLock

func NewRedLock(addrs []string) (*RedLock, error)

NewRedLock creates a RedLock

func (*RedLock) Lock

func (r *RedLock) Lock(resource string, ttl int) (int64, error)

Lock acquires a distribute lock

func (*RedLock) SetRetryCount

func (r *RedLock) SetRetryCount(count int)

SetRetryCount sets acquire lock retry count

func (*RedLock) SetRetryDelay

func (r *RedLock) SetRetryDelay(delay int)

SetRetryDelay sets acquire lock retry max internal in millisecond

func (*RedLock) UnLock

func (r *RedLock) UnLock(resource string) error

UnLock releases an acquired lock

type SimpleCache

type SimpleCache struct {
	// contains filtered or unexported fields
}

SimpleCache is the most negative implementation of KVCache interface

func NewSimpleCache

func NewSimpleCache() *SimpleCache

NewSimpleCache creates a new SimpleCache object

func (*SimpleCache) Delete

func (sc *SimpleCache) Delete(key string)

Delete implements KVCache.Delete

func (*SimpleCache) GC

func (sc *SimpleCache) GC()

GC implements KVCache.GC

func (*SimpleCache) Get

func (sc *SimpleCache) Get(key string) *LockElem

Get implements KVCache.Get

func (*SimpleCache) Set

func (sc *SimpleCache) Set(key, val string, expiry int64) *LockElem

Set implements KVCache.Set

func (*SimpleCache) Size

func (sc *SimpleCache) Size() int

Size implements KVCache.Size