locking

Documentation

Index

• Variables
• func RegisterLocker(name string, provider LockerProvider)
• type InMemLocker
  • func NewInMemLocker() *InMemLocker
  • func (l *InMemLocker) Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)
  • func (l *InMemLocker) Close() error
  • func (l *InMemLocker) Release(ctx context.Context, key string) error
• type Locker
• type LockerProvider
  • func GetLocker(name string) (LockerProvider, bool)

Variables

var (
	ErrLockAcquisitionTimeout = mdk.ErrLockAcquisitionTimeout
	ErrLockNotHeld            = mdk.ErrLockNotHeld
)

var LockOwnerKey = mdk.LockOwnerKey

Functions

func RegisterLocker

func RegisterLocker(name string, provider LockerProvider)

Types

type InMemLocker

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

InMemLocker is a simple thread-safe in-memory locker.

func NewInMemLocker

func NewInMemLocker() *InMemLocker

NewInMemLocker creates a new InMemLocker.

func (*InMemLocker) Acquire

func (l *InMemLocker) Acquire(ctx context.Context, key string, ttl time.Duration, timeout time.Duration) (bool, error)

func (*InMemLocker) Close

func (l *InMemLocker) Close() error

func (*InMemLocker) Release

func (l *InMemLocker) Release(ctx context.Context, key string) error

type Locker

type Locker = mdk.Locker

Locker defines the interface for distributed locking.

type LockerProvider

type LockerProvider = mdk.LockerProvider

func GetLocker

func GetLocker(name string) (LockerProvider, bool)