Package0.1.2SystemConcurrency
lukko
File locking
- Version0.1.2
- CategorySystem, Concurrency
- LicenceGPL-2.0-or-later AND BSD-3-Clause
- MaintainerOleg Grenrus <oleg.grenrus@iki.fi>
- Pinned byhackage lukko 0.1.2
- Sourcehackage.haskell.org/package/lukko-0.1.2
Modules
4 modules- Lukko16Open Handle based locking
- Lukko.FLock15File locking via BSD-style flock(2).
- Lukko.NoOp15Non-operating locks. All functions throw FileLockingNotImplemented.
- Lukko.OFD15Linux open file descriptor locking. https://www.gnu.org/software/libc/manual/html_node/Open-File-Description-Locks.html We prefer this ov…
Description
This package provides access to platform dependent file locking APIs:
Open file descriptor locking on Linux (Lukko.OFD) BSD-style flock(2) locks on UNIX platforms (Lukko.FLock) Windows locking via LockFileEx (Lukko.Windows) No-op locking, which throws exceptions (Lukko.NoOp) Lukko module exports the best option for the target platform with uniform API.
There are alternative file locking packages:
GHC.IO.Handle.Lock in base >= 4.10 is good enough for most use cases. However, uses only Handles so these locks cannot be used for intra-process locking. (You should use e.g. MVar in addition). filelock doesn't support OFD locking.
Lukko means lock in Finnish.
Submodules Lukko.OFD, Lukko.Windows etc are available based on following conditions.
if os(windows) cpp-options: -DHAS_WINDOWS_LOCK elif (os(linux) && flag(ofd-locking)) cpp-options: -DHAS_OFD_LOCKING cpp-options: -DHAS_FLOCK elif !(os(solaris) || os(aix)) cpp-options: -DHAS_FLOCK
Lukko.FLock is available on not (Windows or Solaris or AIX). Lukko.NoOp is always available.
Depends on
1 package- base-4.20.2.0with GHC