lock

Documentation

Index

• type ErrAlreadyLocked
  • func (e *ErrAlreadyLocked) Error() string
• type EtcdLock
  • func (l *EtcdLock) Release() error
• type EtcdLocker
  • func (locker *EtcdLocker) Acquire(ctx context.Context, key string, ttl int) (Lock, error)
  • func (locker *EtcdLocker) Wait(ctx context.Context, key string) error
  • func (locker *EtcdLocker) WaitAcquire(ctx context.Context, key string, ttl int) (Lock, error)
• type EtcdLockerOpt
  • func WithCooldownTryLockDuration(timeout time.Duration) EtcdLockerOpt
  • func WithMaxTryLockTimeout(timeout time.Duration) EtcdLockerOpt
  • func WithTryLockTimeout(timeout time.Duration) EtcdLockerOpt
• type Lock
• type Locker
  • func NewEtcdLocker(client *etcd.Client, opts ...EtcdLockerOpt) Locker

Types

type ErrAlreadyLocked

type ErrAlreadyLocked struct{}

func (*ErrAlreadyLocked) Error

func (e *ErrAlreadyLocked) Error() string

type EtcdLock

type EtcdLock struct {
	*sync.Mutex
	// contains filtered or unexported fields
}

func (*EtcdLock) Release

func (l *EtcdLock) Release() error

type EtcdLocker

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

func (*EtcdLocker) Acquire

func (locker *EtcdLocker) Acquire(ctx context.Context, key string, ttl int) (Lock, error)

func (*EtcdLocker) Wait

func (locker *EtcdLocker) Wait(ctx context.Context, key string) error

func (*EtcdLocker) WaitAcquire

func (locker *EtcdLocker) WaitAcquire(ctx context.Context, key string, ttl int) (Lock, error)

type EtcdLockerOpt

type EtcdLockerOpt func(locker *EtcdLocker)

func WithCooldownTryLockDuration

func WithCooldownTryLockDuration(timeout time.Duration) EtcdLockerOpt

func WithMaxTryLockTimeout

func WithMaxTryLockTimeout(timeout time.Duration) EtcdLockerOpt

func WithTryLockTimeout

func WithTryLockTimeout(timeout time.Duration) EtcdLockerOpt

type Lock

type Lock interface {
	Release() error
}

type Locker

type Locker interface {
	Acquire(ctx context.Context, key string, ttl int) (Lock, error)
	WaitAcquire(ctx context.Context, key string, ttl int) (Lock, error)
	Wait(ctx context.Context, key string) error
}

func NewEtcdLocker

func NewEtcdLocker(client *etcd.Client, opts ...EtcdLockerOpt) Locker