lock

Documentation

Index

• Variables
• type Configuration
• type Lock
  • func LockTask(name string, options ...Options) (Lock, error)
  • func TryLockTask(name string, options ...Options) (Lock, error)
• type LockProvider
• type Options
  • func WithLockAtMost(atMost time.Duration) Options
  • func WithLockTimeout(timeout time.Duration) Options
  • func WithProvider(provider LockProvider) Options

Variables

var (
	ErrLockFailed        = errors.New("unable to get lock")
	ErrProviderNotFound  = errors.New("provider not specified")
	ErrLockAtMostMissing = errors.New("lock time at most not specified")
	ErrTimeout           = errors.New("lock failed: waiting timeout")

	CurrentIp string
)

Types

type Configuration

type Configuration struct {
	Provider    LockProvider
	Name        string
	LockAtMost  time.Duration
	LockTimeout time.Duration
	LockBy      string
}

type Lock

type Lock interface {
	Unlock() error
}

func LockTask

func LockTask(name string, options ...Options) (Lock, error)

LockTask try to get lock and launch task if succeed. Block if failed to get the lock. If lockTimeout is specified with and positive value, LockTask would wait for at most timeout.

func TryLockTask

func TryLockTask(name string, options ...Options) (Lock, error)

TryLockTask try to get lock and launch task if succeed. It returns error immediately if failed to get the lock. lockTimeout is useless for the method

type LockProvider

type LockProvider interface {
	Lock(Configuration) (Lock, error)

	TryLock(Configuration) (Lock, error)
}

type Options

type Options interface {
	Apply(opt *Configuration)
}

domain interfaces

func WithLockAtMost

func WithLockAtMost(atMost time.Duration) Options

WithLockAtMost specifies the maximum holding time of the lock. If atMost added by now arrives and the task has not finished, the lock would be release by force. If atMost is not positive, the lock will be always held until it's released explicitly.

func WithLockTimeout

func WithLockTimeout(timeout time.Duration) Options

WithLockTimeout specifies the maximum waiting time when required lock is held by others. If timeout added by now arrives and the lock is still unavailable, LockTask would stop waiting and an error would be returned. Timeout is useless for TryLockTask method.

func WithProvider

func WithProvider(provider LockProvider) Options