filelock

README

filelock

This library will allow locking a file for synchronous operation.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/filelock.

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Garden Containers area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation

Index

• type FileLocker
  • func NewLocker(path string) FileLocker
• type LockedFile
• type Locker
  • func (l *Locker) Lock() error
  • func (l *Locker) Unlock() error

Types

type FileLocker

type FileLocker interface {
	Open() (LockedFile, error)
}

func NewLocker

func NewLocker(path string) FileLocker

type LockedFile

type LockedFile interface {
	Close() error
	Read([]byte) (int, error)
	Truncate(int64) error
	Write([]byte) (int, error)
	Seek(int64, int) (int64, error)
}

type Locker

type Locker struct {
	FileLocker FileLocker
	Mutex      *sync.Mutex
	// contains filtered or unexported fields
}

func (*Locker) Lock

func (l *Locker) Lock() error

func (*Locker) Unlock

func (l *Locker) Unlock() error