lock

Documentation

Index

• type Option
  • func WithAutoRenew() Option
  • func WithKey(key string) Option
  • func WithTimeout(timeout time.Duration) Option
  • func WithToken(token string) Option
• type RedisLock
  • func (lock *RedisLock) Lock() error
  • func (lock *RedisLock) Renew() error
  • func (lock *RedisLock) SpinLock(timeout time.Duration) error
  • func (lock *RedisLock) UnLock() error
• type RedisLockInter
  • func New(ctx context.Context, redisClient *redis.Client, lockKey string, ...) RedisLockInter

Types

type Option

type Option func(lock *RedisLock)

func WithAutoRenew

func WithAutoRenew() Option

WithAutoRenew 是否开启自动续期

func WithKey

func WithKey(key string) Option

WithKey 设置锁的key

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout 设置锁过期时间

func WithToken

func WithToken(token string) Option

WithToken 设置锁的Token

type RedisLock

type RedisLock struct {
	context.Context
	*redis.Client
	// contains filtered or unexported fields
}

func (*RedisLock) Lock

func (lock *RedisLock) Lock() error

Lock 加锁

func (*RedisLock) Renew

func (lock *RedisLock) Renew() error

Renew 锁手动续期

func (*RedisLock) SpinLock

func (lock *RedisLock) SpinLock(timeout time.Duration) error

SpinLock 自旋锁

func (*RedisLock) UnLock

func (lock *RedisLock) UnLock() error

UnLock 解锁

type RedisLockInter

type RedisLockInter interface {
	// Lock 加锁
	Lock() error

	// UnLock 解锁
	UnLock() error

	// SpinLock 自旋锁
	SpinLock(timeout time.Duration) error

	// Renew 手动续期
	Renew() error
}

func New

func New(ctx context.Context, redisClient *redis.Client, lockKey string, options ...Option) RedisLockInter