locker

Jan 20, 2021

Changes in this version

+ var ErrUnexpectedRedisResponse = errors.New("locker: unexpected redis response")

+ type LockResult struct

Dec 17, 2020

Changes in this version

+ type RedisClient interface

+ Eval func(ctx context.Context, script string, keys []string, args ...interface{}) *redis.Cmd

+ EvalSha func(ctx context.Context, sha1 string, keys []string, args ...interface{}) *redis.Cmd

+ ScriptExists func(ctx context.Context, hashes ...string) *redis.BoolSliceCmd

+ ScriptLoad func(ctx context.Context, script string) *redis.StringCmd

+ type Result struct

+ func (r Result) OK() bool

+ func (r Result) TTL() time.Duration

Aug 8, 2019

Changes in this version

+ const ErrInvalidRandSize

type Locker

+ func New(ttl time.Duration, options ...Option) (*Locker, error)

type Option

+ func WithGateway(v Gateway) Option

+ func WithRandReader(v io.Reader) Option

+ func WithRandSize(v int) Option

Aug 4, 2019

Changes in this version

+ func WithContext(ctx context.Context) func(lk *Lock)

+ type Opt func(lk *Lock)

+ type Option func(lk *Locker) error

Aug 2, 2019

Changes in this version

+ const MaxKeySize

+ var ErrInvalidKey = errors.New("Key size must be less than or equal to 512 MB")

+ var ErrInvalidRetryCount = errors.New("RetryCount must be greater than or equal to zero")

+ var ErrInvalidRetryDelay = errors.New("RetryDelay must be greater than or equal to 1 millisecond")

+ var ErrInvalidRetryJitter = errors.New("RetryJitter must be greater than or equal to 1 millisecond")

+ var ErrInvalidTTL = errors.New("TTL must be greater than or equal to 1 millisecond")

+ type Func func(lk *Locker) error

+ func WithPrefix(v string) Func

+ func WithRetryCount(v int) Func

+ func WithRetryDelay(v time.Duration) Func

+ func WithRetryJitter(v time.Duration) Func

+ type Gateway interface

+ Del func(key, value string) (bool, error)

+ Set func(key, value string, ttl int) (bool, int, error)

+ type Lock struct

+ func (lk *Lock) Lock() (bool, int, error)

+ func (lk *Lock) Unlock() (bool, error)

+ type Locker struct

+ func NewLocker(client *redis.Client, ttl time.Duration, options ...Func) (*Locker, error)

+ func NewLockerWithGateway(gateway Gateway, ttl time.Duration, options ...Func) (*Locker, error)

+ func (lk *Locker) Lock(key string) (*Lock, error)

+ func (lk *Locker) LockWithContext(ctx context.Context, key string) (*Lock, error)

+ func (lk *Locker) NewLock(key string) (*Lock, error)

+ func (lk *Locker) NewLockWithContext(ctx context.Context, key string) (*Lock, error)

+ type TTLError interface

+ Error func() string

+ TTL func() time.Duration