diff options
Diffstat (limited to 'vendor/github.com/juju/fslock/README.md')
| -rw-r--r-- | vendor/github.com/juju/fslock/README.md | 74 |
1 files changed, 0 insertions, 74 deletions
diff --git a/vendor/github.com/juju/fslock/README.md b/vendor/github.com/juju/fslock/README.md deleted file mode 100644 index 4361b9d..0000000 --- a/vendor/github.com/juju/fslock/README.md +++ /dev/null @@ -1,74 +0,0 @@ - -# fslock [](https://godoc.org/github.com/juju/fslock) -fslock provides a cross-process mutex based on file locks that works on windows and *nix platforms. - - - - -<sup><sub>image: [public domain](https://pixabay.com/en/encrypted-privacy-policy-445155/) -(don't ask) -</sub></sup> - -fslock relies on LockFileEx on Windows and flock on \*nix systems. The timeout -feature uses overlapped IO on Windows, but on \*nix platforms, timing out -requires the use of a goroutine that will run until the lock is acquired, -regardless of timeout. If you need to avoid this use of goroutines, poll -TryLock in a loop. - - - -## Variables -``` go -var ErrLocked error = trylockError("fslock is already locked") -``` -ErrLocked indicates TryLock failed because the lock was already locked. - -``` go -var ErrTimeout error = timeoutError("lock timeout exceeded") -``` -ErrTimeout indicates that the lock attempt timed out. - - -## type Lock -``` go -type Lock struct { - // contains filtered or unexported fields -} -``` -Lock implements cross-process locks using syscalls. - - -### func New -``` go -func New(filename string) *Lock -``` -New returns a new lock around the given file. - - -### func (\*Lock) Lock -``` go -func (l *Lock) Lock() error -``` -Lock locks the lock. This call will block until the lock is available. - -### func (\*Lock) LockWithTimeout -``` go -func (l *Lock) LockWithTimeout(timeout time.Duration) error -``` -LockWithTimeout tries to lock the lock until the timeout expires. If the -timeout expires, this method will return ErrTimeout. - -### func (\*Lock) TryLock -``` go -func (l *Lock) TryLock() error -``` -TryLock attempts to lock the lock. This method will return ErrLocked -immediately if the lock cannot be acquired. - -### func (\*Lock) Unlock -``` go -func (l *Lock) Unlock() error -``` -Unlock unlocks the lock. - - |