Package Info

ghc-lukko


File locking


Unspecified

This package provides access to platform dependent file locking APIs:

<https://www.gnu.org/software/libc/manual/html_node/Open-File-Description-Locks.html Open file descriptor locking> on Linux ("Lukko.OFD") * BSD-style 'flock(2)' locks on UNIX platforms ("Lukko.FLock") * Windows locking via <https://docs.microsoft.com/en-us/windows/win32/api/fileapi/nf-fileapi-lockfilee 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 'Handle's so these locks cannot be used for intra-process locking. (You should use e.g. 'MVar' in addition).

  • <https://hackage.haskell.org/package/filelock 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.


License: GPL-2.0-or-later AND BSD-3-Clause
URL: https://hackage.haskell.org/package/lukko

Categories

Releases

Package Version Update ID Released Package Hub Version Platforms Subpackages
0.1.1.3-bp155.3.16 info GA Release 2023-05-22 15 SP5
  • AArch64
  • ppc64le
  • s390x
  • x86-64
  • ghc-lukko
  • ghc-lukko-devel
0.1.1.3-bp154.2.11 info GA Release 2022-05-09 15 SP4
  • AArch64
  • ppc64le
  • x86-64
  • ghc-lukko
  • ghc-lukko-devel
0.1.1.2-bp153.1.20 info GA Release 2021-04-08 15 SP3
  • AArch64
  • ppc64le
  • x86-64
  • ghc-lukko
  • ghc-lukko-devel
0.1.1.2-bp152.1.2 info GA Release 2020-06-16 15 SP2
  • AArch64
  • ppc64le
  • x86-64
  • ghc-lukko
  • ghc-lukko-devel