The lock-file package

[Tags:bsd3, library, test]

Provide exclusive access to a resource using lock file, which are files whose purpose is to signal by their presence that some resource is locked.

Code example can be found in System.IO.LockFile module.


[Skip to Readme]

Properties

Versions 0.5.0.0, 0.5.0.1, 0.5.0.2
Change log ChangeLog.md
Dependencies base (>=4.5 && <5), data-default-class (>=0.0 && <0.2), directory (>=1.1 && <1.4), exceptions (>0.6 && <0.9), tagged-exception-core (>=2.0.0.0 && <3), transformers (>=0.3 && <0.6) [details]
License BSD3
Copyright (c) 2013-2015, Peter Trško
Author Peter Trsko
Maintainer peter.trsko@gmail.com
Category System
Home page https://github.com/trskop/lock-file
Bug tracker https://github.com/trskop/lock-file/issues
Source repository head: git clone git://github.com/trskop/lock-file.git
this: git clone git://github.com/trskop/lock-file.git(tag 0.5.0.2)
Uploaded Sun Jun 14 22:01:24 UTC 2015 by PeterTrsko
Updated Mon Mar 6 21:42:12 UTC 2017 by PeterTrsko to revision 4
Distributions NixOS:0.5.0.2
Downloads 498 total (16 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2015-06-14 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
pedanticPass additional warning flags to GHC.DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for lock-file

Readme for lock-file-0.5.0.2

Lock File

Hackage Haskell Programming Language BSD3 License

Build

Description

Provide exclusive access to a resource using lock file, which are files whose purpose is to signal by their presence that some resource is locked.

Usage Example

Following example acquires lock file and then waits 1000000 micro seconds before releasing it. Note also that it is possible to specify retry strategy. Here we set it to No and therefore this code won't retry to acquire lock file after first failure.

module Main (main)
    where

import Control.Concurrent (threadDelay)
    -- From base package, but GHC specific.

import qualified Control.Monad.TaggedException as Exception (handle)
    -- From tagged-exception-core package.
    -- http://hackage.haskell.org/package/tagged-exception-core
import Data.Default.Class (Default(def))
    -- From data-default-class package, alternatively it's possible to use
    -- data-default package version 0.5.2 and above.
    -- http://hackage.haskell.org/package/data-default-class
    -- http://hackage.haskell.org/package/data-default
import System.IO.LockFile
    ( LockingParameters(retryToAcquireLock)
    , RetryStrategy(No)
    , withLockFile
    )


main :: IO ()
main = handleException
    . withLockFile lockParams lockFile $ threadDelay 1000000
  where
    lockParams = def
        { retryToAcquireLock = No
        }

    lockFile = "/var/run/lock/my-example-lock"

    handleException = Exception.handle
        $ putStrLn . ("Locking failed with: " ++) . show

This command line example shows that trying to execute two instances of example at the same time will result in failure of the second one.

$ ghc example.hs
[1 of 1] Compiling Main             ( example.hs, example.o )
Linking example ...
$ ./example & ./example
[1] 7893
Locking failed with: Unable to acquire lock file: "/var/run/lock/my-example-lock"
$ [1]+  Done                    ./example

Building options

  • -fpedantic (disabled by default)

    Pass additional warning flags to GHC.