lock

Documentation

Index

• Constants
• type EtcdLock
  • func NewEtcdLock(client *v3.Client, key string, opts ...concurrency.SessionOption) (mutex *EtcdLock, err error)
  • func (l *EtcdLock) Lock(ctx context.Context, timeout time.Duration) (b bool, err error)
  • func (l *EtcdLock) Unlock(ctx context.Context) (b bool, err error)
• type Lock
• type RedisLock
  • func NewRedisLock(rdb *redis.Client, key string) *RedisLock
  • func (l *RedisLock) Lock(ctx context.Context, timeout time.Duration) (bool, error)
  • func (l *RedisLock) Unlock(ctx context.Context) (bool, error)

Constants

const (
	// RedisLockKey redis lock key
	RedisLockKey = "gole:redis:lock:%s"
	// EtcdLockKey etcd lock key
	EtcdLockKey = "/gole/lock/%s"
)

Types

type EtcdLock

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

EtcdLock define a etcd lock

func NewEtcdLock

func NewEtcdLock(client *v3.Client, key string, opts ...concurrency.SessionOption) (mutex *EtcdLock, err error)

NewEtcdLock create a etcd lock

func (*EtcdLock) Lock

func (l *EtcdLock) Lock(ctx context.Context, timeout time.Duration) (b bool, err error)

Lock acquires the lock.

func (*EtcdLock) Unlock

func (l *EtcdLock) Unlock(ctx context.Context) (b bool, err error)

Unlock release a lock.

type Lock

type Lock interface {
	Lock(ctx context.Context, timeout time.Duration) (bool, error)
	Unlock(ctx context.Context) (bool, error)
}

Lock define common func

type RedisLock

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

RedisLock is a redis lock.

func NewRedisLock

func NewRedisLock(rdb *redis.Client, key string) *RedisLock

NewRedisLock new a redis lock instance nolint

func (*RedisLock) Lock

func (l *RedisLock) Lock(ctx context.Context, timeout time.Duration) (bool, error)

Lock acquires the lock.

func (*RedisLock) Unlock

func (l *RedisLock) Unlock(ctx context.Context) (bool, error)

Unlock del the lock. NOTE: token 一致才会执行删除，避免误删，这里用了lua脚本进行事务处理