filelock

README

Go file locking

Overview

Exclusive file locks with timeouts using flock.

Example

  // Try to obtain an exclusive file lock with a timeout
  lock := filelock.FileLock{Path: "example.lock", Timeout: time.Second * 1}
  err := lock.Lock()
  if err != nil {
    if err == ErrLockTimeout {
      // Lock timeout
    }

    // Other error
  }

  // Lock obtained successfully, must be released.
  defer lock.Unlock()

See tests for more examples.

License

Apache 2.0

Documentation

Index

• Variables
• type FileLock
  • func (l *FileLock) Lock() error
  • func (l *FileLock) Unlock() error

Variables

var ErrLockTimeout = errors.New("timeout obtaining lock")

var ErrNotLocked = errors.New("not locked")

Types

type FileLock

type FileLock struct {
	Path    string
	Timeout time.Duration
	// contains filtered or unexported fields
}

func (*FileLock) Lock

func (l *FileLock) Lock() error

func (*FileLock) Unlock

func (l *FileLock) Unlock() error