package filelock
import "cmd/go/internal/lockedfile/internal/filelock"
Package filelock provides a platform-independent API for advisory file locking. Calls to functions in this package on platforms that do not support advisory locks will return errors for which IsNotSupported returns true.
Index ¶
- Variables
- func IsNotSupported(err error) bool
- func Lock(f File) error
- func RLock(f File) error
- func Unlock(f File) error
- type File
Variables ¶
Functions ¶
func IsNotSupported ¶
IsNotSupported returns a boolean indicating whether the error is known to report that a function is not supported (possibly for a specific input). It is satisfied by ErrNotSupported as well as some syscall errors.
func Lock ¶
Lock places an advisory write lock on the file, blocking until it can be locked.
If Lock returns nil, no other process will be able to place a read or write lock on the file until this process exits, closes f, or calls Unlock on it.
If f's descriptor is already read- or write-locked, the behavior of Lock is unspecified.
Closing the file may or may not release the lock promptly. Callers should ensure that Unlock is always called when Lock succeeds.
func RLock ¶
RLock places an advisory read lock on the file, blocking until it can be locked.
If RLock returns nil, no other process will be able to place a write lock on the file until this process exits, closes f, or calls Unlock on it.
If f is already read- or write-locked, the behavior of RLock is unspecified.
Closing the file may or may not release the lock promptly. Callers should ensure that Unlock is always called if RLock succeeds.
func Unlock ¶
Unlock removes an advisory lock placed on f by this process.
The caller must not attempt to unlock a file that is not locked.
Types ¶
type File ¶
type File interface { // Name returns the name of the file. Name() string // Fd returns a valid file descriptor. // (If the File is an *os.File, it must not be closed.) Fd() uintptr // Stat returns the FileInfo structure describing file. Stat() (os.FileInfo, error) }
A File provides the minimal set of methods required to lock an open file. File implementations must be usable as map keys. The usual implementation is *os.File.
Source Files ¶
- Version
- v1.14.14
- Published
- Jan 19, 2021
- Platform
- linux/amd64
- Imports
- 3 packages
- Last checked
- 4 seconds ago –
Tools for package owners.