filelock

Documentation

Index

• func ExpectLockUnlock(fileLockerMock *FileLockerMock, lockPath string, ownerId string)
• func GetOwnerIdForProcess() string
• func LockFile(lockPath string, ownerId string, timeoutSeconds int) (locked bool, err error)
• func UnlockFile(lockPath string, ownerId string) (hadLock bool, err error)
• type FileLocker
  • func NewFileLocker() FileLocker
• type FileLockerMock
  • func (fl *FileLockerMock) Lock(lockPath string, ownerId string, timeoutSeconds int) (locked bool, err error)
  • func (fl *FileLockerMock) Unlock(lockPath string, ownerId string) (hadLock bool, err error)
• type FileLockerNoop
  • func (fl *FileLockerNoop) Lock(lockPath string, ownerId string, timeoutSeconds int) (locked bool, err error)
  • func (fl *FileLockerNoop) Unlock(lockPath string, ownerId string) (hadLock bool, err error)

Functions

func ExpectLockUnlock

func ExpectLockUnlock(fileLockerMock *FileLockerMock, lockPath string, ownerId string)

func GetOwnerIdForProcess

func GetOwnerIdForProcess() string

func LockFile

func LockFile(lockPath string, ownerId string, timeoutSeconds int) (locked bool, err error)

func UnlockFile

func UnlockFile(lockPath string, ownerId string) (hadLock bool, err error)

Types

type FileLocker

type FileLocker interface {
	Lock(lockPath string, ownerId string, timeoutSeconds int) (locked bool, err error)
	Unlock(lockPath string, ownerId string) (hadLock bool, err error)
}

func NewFileLocker

func NewFileLocker() FileLocker

type FileLockerMock

type FileLockerMock struct {
	mock.Mock
}

func (*FileLockerMock) Lock

func (fl *FileLockerMock) Lock(lockPath string, ownerId string, timeoutSeconds int) (locked bool, err error)

func (*FileLockerMock) Unlock

func (fl *FileLockerMock) Unlock(lockPath string, ownerId string) (hadLock bool, err error)

type FileLockerNoop

type FileLockerNoop struct{}

func (*FileLockerNoop) Lock

func (fl *FileLockerNoop) Lock(lockPath string, ownerId string, timeoutSeconds int) (locked bool, err error)

func (*FileLockerNoop) Unlock

func (fl *FileLockerNoop) Unlock(lockPath string, ownerId string) (hadLock bool, err error)