filelock

Documentation

Index

• Constants
• type FileLock
  • func NewFileLock(lockName string) *FileLock
  • func (fl *FileLock) Acquire() error
  • func (fl *FileLock) Release() error

Constants

const LogRotateLockName = "logrotate_run.lock"

LogRotateLockName used to lock processes which can touch /var/log/vic logs to avoid race condition during export and logrotate run.

Types

type FileLock

type FileLock struct {
	LockFile string
	LockName string
	// contains filtered or unexported fields
}

FileLock is a cross-process lock designed to work over FS that supports locking.

func NewFileLock

func NewFileLock(lockName string) *FileLock

NewFileLock returns a new instance of the file based lock. it is a user responsibility to ensure lock name is unique and doesn't collide with any other file names in the TEMP directory.

func (*FileLock) Acquire

func (fl *FileLock) Acquire() error

Acquire grabs the lock. If lock is already acquired, it will block. User should check for errors if lock is actually acquired, if lock is not acquired it will panic on Release.

func (*FileLock) Release

func (fl *FileLock) Release() error

Release lock. If lock is not acquired, it will panic.