Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

distlock

package module

Go to main page

Versions in this module

v0

v0.2.0

Jul 19, 2021

Changes in this version

+ func Ensure(ctx context.Context, cli RedisClient, lock Lock, ttl time.Duration) error

type Client

+ func (c *Client) Ensure(ctx context.Context, lock Lock, ttl time.Duration) error

type Lock

+ func NewLock(key, token string) Lock

+ func (lock Lock) GetToken() string

+ func (lock Lock) Refresh(ctx context.Context, cli RedisClient, ttl time.Duration) error

+ func (lock Lock) Release(ctx context.Context, cli RedisClient) error

+ func (lock Lock) TTL(ctx context.Context, cli RedisClient) (time.Duration, error)

v0.1.0

Nov 9, 2020

Changes in this version

+ var ErrLockNotHeld = errors.New("distlock: lock not held")

+ var ErrNotObtained = errors.New("distlock: not obtained")

+ var File_lock_proto protoreflect.FileDescriptor

+ func Refresh(ctx context.Context, client RedisClient, lock *Lock, ttl time.Duration) error

+ func Release(ctx context.Context, client RedisClient, lock *Lock) error

+ func TTL(ctx context.Context, client RedisClient, lock *Lock) (time.Duration, error)

+ type Client struct

+ func New(client RedisClient) *Client

+ func (c *Client) Obtain(ctx context.Context, key string, ttl time.Duration, opts ...Option) (*Lock, error)

+ func (c *Client) Refresh(ctx context.Context, lock *Lock, ttl time.Duration) error

+ func (c *Client) Release(ctx context.Context, lock *Lock) error

+ func (c *Client) TTL(ctx context.Context, lock *Lock) (time.Duration, error)

+ type EasyLock struct

+ func Bind(lock *Lock, client RedisClient) *EasyLock

+ func (l *EasyLock) Refresh(ctx context.Context, ttl time.Duration) error

+ func (l *EasyLock) Release(ctx context.Context) error

+ func (l *EasyLock) TTL(ctx context.Context) (time.Duration, error)

+ type Lock struct

+ Key string

+ Value string

+ func Obtain(ctx context.Context, client RedisClient, key string, ttl time.Duration, ...) (*Lock, error)

+ func (*Lock) Descriptor() ([]byte, []int)

+ func (*Lock) ProtoMessage()

+ func (l *Lock) Metadata() string

+ func (l *Lock) Token() string

+ func (x *Lock) GetKey() string

+ func (x *Lock) GetValue() string

+ func (x *Lock) ProtoReflect() protoreflect.Message

+ func (x *Lock) Reset()

+ func (x *Lock) String() string

+ type Option interface

+ func WithMetadata(metadata string) Option

+ func WithRetryStrategy(strategy RetryStrategy) Option

+ 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, scripts ...string) *redis.BoolSliceCmd

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

+ SetNX func(ctx context.Context, key string, value interface{}, expiration time.Duration) *redis.BoolCmd

+ type RetryStrategy interface

+ NextBackoff func() time.Duration

+ func ExponentialBackoff(min, max time.Duration) RetryStrategy

+ func LimitRetry(s RetryStrategy, max int) RetryStrategy

+ func LinearBackoff(backoff time.Duration) RetryStrategy

+ func NoRetry() RetryStrategy