lock

Documentation

Index

• Variables
• func GetRemoteLockState(ctx context.Context, client *clientv3.Client, lockName string) (bool, int64, error)
• type Locker
  • func NewLocker(c *clientv3.Client, owner string, lock string, ttl int) *Locker
  • func (l *Locker) Close()
  • func (l *Locker) GetLockID() string
  • func (l *Locker) GetLockRev() int64
  • func (l *Locker) Lock(ctx context.Context) error
  • func (l *Locker) Unlock(ctx context.Context) error

Variables

var (
	// ErrLockerClosed 锁已被关闭
	ErrLockerClosed = errors.New("locker has closed")
	// ErrLocked 锁已被其他人持有
	ErrLocked = errors.New("locked by another session")
	// ErrSessionExpired 锁会话过期
	ErrSessionExpired = errors.New("session is expired")
	// ErrLockFailed 锁失败
	ErrLockFailed = errors.New("lock failed")
	// ErrLockRemoteNoneNeedTodo 远程锁未被占有，需要开启抢占
	ErrLockRemoteNoneNeedTodo = errors.New("remote lock is none, need to start grab")
)

Functions

func GetRemoteLockState

func GetRemoteLockState(ctx context.Context, client *clientv3.Client, lockName string) (bool, int64, error)

GetRemoteLockState 获取远程锁的状态

Types

type Locker

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

Locker 分布式锁

func NewLocker

func NewLocker(c *clientv3.Client, owner string, lock string, ttl int) *Locker

NewLocker 新建分布式锁实例，注意，如果不再使用，请调用Close.

func (*Locker) Close

func (l *Locker) Close()

Close 关闭释放锁，不可再用

func (*Locker) GetLockID

func (l *Locker) GetLockID() string

GetLockID 获取锁的ID

func (*Locker) GetLockRev

func (l *Locker) GetLockRev() int64

GetLockRev 获取锁的版本号

func (*Locker) Lock

func (l *Locker) Lock(ctx context.Context) error

Lock 上锁

func (*Locker) Unlock

func (l *Locker) Unlock(ctx context.Context) error

Unlock 解锁，可继续Lock