file_lock

Documentation

Index

• Variables
• type BaseLock
  • func (lock *BaseLock) GetName() string
  • func (lock *BaseLock) Lock(l locker) error
  • func (lock *BaseLock) TryLock(l locker) (bool, error)
  • func (lock *BaseLock) Unlock(l locker) error
• type FileLock
  • func (lock *FileLock) Lock(timeout time.Duration, readOnly bool, onWait func(doWait func() error) error) error
  • func (lock *FileLock) LockFilePath() string
  • func (lock *FileLock) TryLock(readOnly bool) (bool, error)
  • func (lock *FileLock) Unlock() error
• type LockObject
  • func NewFileLock(name, locksDir string) LockObject

Variables

var LegacyHashFunction = false

Types

type BaseLock

type BaseLock struct {
	Name        string
	ActiveLocks int
}

func (*BaseLock) GetName

func (lock *BaseLock) GetName() string

func (*BaseLock) Lock

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

func (*BaseLock) TryLock

func (lock *BaseLock) TryLock(l locker) (bool, error)

func (*BaseLock) Unlock

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

type FileLock

type FileLock struct {
	BaseLock
	LocksDir string
	// contains filtered or unexported fields
}

func (*FileLock) Lock

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

func (*FileLock) LockFilePath

func (lock *FileLock) LockFilePath() string

func (*FileLock) TryLock

func (lock *FileLock) TryLock(readOnly bool) (bool, error)

func (*FileLock) Unlock

func (lock *FileLock) Unlock() error

type LockObject

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

func NewFileLock

func NewFileLock(name, locksDir string) LockObject