locker

Documentation

Index

• Constants
• Variables
• type Locker
  • func InitRedisLocker(logger *zap.Logger, client *redis.Client) Locker
• type RedisLocker
  • func (r *RedisLocker) Lock(ctx context.Context, resource string) (Release, error)
  • func (r *RedisLocker) LockWithtimeout(ctx context.Context, resource string, timeout time.Duration) (Release, error)
  • func (r *RedisLocker) WaitForLocker(ctx context.Context, resource string, maxWait time.Duration, ...) (Release, error)
• type Release

Constants

const (
	LockerPrefix = "_locker_"
)

Variables

var MaxLockerDuration time.Duration = 30 * time.Minute

var WaitInteval time.Duration = 50 * time.Millisecond

Types

type Locker

type Locker interface {
	Lock(ctx context.Context, resource string) (Release, error)
	WaitForLocker(ctx context.Context, resource string, maxWait time.Duration, timeout time.Duration) (Release, error)
	LockWithtimeout(ctx context.Context, resource string, timeout time.Duration) (Release, error)
}

func InitRedisLocker

func InitRedisLocker(logger *zap.Logger, client *redis.Client) Locker

type RedisLocker

type RedisLocker struct {
	Logger *zap.Logger
	// contains filtered or unexported fields
}

func (*RedisLocker) Lock

func (r *RedisLocker) Lock(ctx context.Context, resource string) (Release, error)

func (*RedisLocker) LockWithtimeout

func (r *RedisLocker) LockWithtimeout(ctx context.Context, resource string, timeout time.Duration) (Release, error)

func (*RedisLocker) WaitForLocker

func (r *RedisLocker) WaitForLocker(ctx context.Context, resource string, maxWait time.Duration, timeout time.Duration) (Release, error)

func (r *RedisLocker) Init() {
	c := redis.NewClient(r.RedisOptions)
	r.client = c
	r.Logger.Info("redis locker ready.", zap.String("redis", r.RedisOptions.Addr))
}

type Release

type Release func(context.Context) error