lock

Documentation

Index

• Variables
• func Init() error
• func Lock(name string, opts LockOptions) error
• func Unlock(name string) error
• func WithLock(name string, opts LockOptions, f func() error) error
• type Base
  • func (lock *Base) GetName() string
  • func (lock *Base) Lock(l locker) error
  • func (lock *Base) Unlock(l locker) error
  • func (lock *Base) WithLock(locker locker, f func() error) error
• type File
  • func (lock *File) Lock(timeout time.Duration, readOnly bool, onWait func(doWait func() error) error) error
  • func (lock *File) Unlock() error
  • func (lock *File) WithLock(timeout time.Duration, readOnly bool, onWait func(doWait func() error) error, ...) error
• type LockObject
  • func NewFileLock(name string, locksDir string) LockObject
• type LockOptions

Variables

var (
	LocksDir       string
	Locks          map[string]LockObject
	DefaultTimeout = 24 * time.Hour
)

Functions

func Init

func Init() error

func Lock

func Lock(name string, opts LockOptions) error

func Unlock

func Unlock(name string) error

func WithLock

func WithLock(name string, opts LockOptions, f func() error) error

Types

type Base

type Base struct {
	Name        string
	ActiveLocks int
}

func (*Base) GetName

func (lock *Base) GetName() string

func (*Base) Lock

func (lock *Base) Lock(l locker) error

func (*Base) Unlock

func (lock *Base) Unlock(l locker) error

func (*Base) WithLock

func (lock *Base) WithLock(locker locker, f func() error) error

type File

type File struct {
	Base
	LocksDir string
	// contains filtered or unexported fields
}

func (*File) Lock

func (lock *File) Lock(timeout time.Duration, readOnly bool, onWait func(doWait func() error) error) error

func (*File) Unlock

func (lock *File) Unlock() error

func (*File) WithLock

func (lock *File) WithLock(timeout time.Duration, readOnly bool, onWait func(doWait func() error) error, f func() error) error

type LockObject

type LockObject interface {
	GetName() string
	Lock(timeout time.Duration, readOnly bool, onWait func(doWait func() error) error) error
	Unlock() error
	WithLock(timeout time.Duration, readOnly bool, onWait func(doWait func() error) error, f func() error) error
}

func NewFileLock

func NewFileLock(name string, locksDir string) LockObject

type LockOptions

type LockOptions struct {
	Timeout  time.Duration
	ReadOnly bool
}