lock

Documentation

Index

• type Lock
  • func NewLock(options Options) Lock
• type Options
• type Unlock
  • func NewUnlock(generation int64) Unlock

Types

type Lock

type Lock interface {
	Generation() int64
	object.SyncOperation
}

func NewLock

func NewLock(options Options) Lock

type Options

type Options struct {
	// ExpiresAfter will delete existing locks older than this age (0 means locks will never expire)
	ExpiresAfter time.Duration
	// BackoffStartingInterval initial sleep time for backoff
	BackoffStartingInterval time.Duration
	// BackoffMultiplier how much to multiply backoff interval after each failed attempt to acquire a lock
	BackoffMultiplier float64
	// MaxWait how long to wait for a lock before timing out
	MaxWait time.Duration
}

Options configuration parameters for a Locker

type Unlock

type Unlock interface {
	object.SyncOperation
}

func NewUnlock

func NewUnlock(generation int64) Unlock