Modulelukko-0.1.2Haskell2010

Lukko.FLock

File locking via BSD-style flock(2).

5 types
10 values

Packagelukko-0.1.2
Exports15
LanguageHaskell2010
LicenceGPL-2.0-or-later AND BSD-3-Clause
SourceFLock.hsc

Types

6 declarations

datadata FileLockingNotSupported

Exception thrown by hLock on non-Windows platforms that don't support flock.

FileLockingNotSupported

Instances2Show, Exception

Show FileLockingNotSupportedDefined in lukko-0.1.2 · Lukko.Internal.Types
Exception FileLockingNotSupportedDefined in lukko-0.1.2 · Lukko.Internal.Types

valuefileLockingSupported :: Bool

A constants specifying whether file locking is supported.

typetype FileLockingSupported = 'True

A type level fileLockingSupported.

datadata FileLockingMethod

Potentially availble lock methods.

Constructors

MethodOFD
open file descriptor locking
MethodFLock
BSD flock
MethodWindows
Windows locking
MethodNoOp
No-Op (throws FileLockingNotSupported)

Instances5Bounded, Enum, Eq, Ord, Show

Bounded FileLockingMethodDefined in lukko-0.1.2 · Lukko.Internal.Types
Enum FileLockingMethodDefined in lukko-0.1.2 · Lukko.Internal.Types
Eq FileLockingMethodDefined in lukko-0.1.2 · Lukko.Internal.Types
Ord FileLockingMethodDefined in lukko-0.1.2 · Lukko.Internal.Types
Show FileLockingMethodDefined in lukko-0.1.2 · Lukko.Internal.Types

valuefileLockingMethod :: FileLockingMethod

A constant specifying this method

datadata LockMode

Indicates a mode in which a file should be locked.

SharedLock ExclusiveLock

File descriptors

6 declarations

newtypenewtype FD

Opaque file descriptor

This is a wrapper over CInt

valuefdOpen :: FilePath -> IO FD

Open file to be used for locking.

open(path, O_RDWR | O_CREAT);

valuefdClose :: FD -> IO ()

Close lock file.

close(fd);

valuefdLock :: FD -> LockMode -> IO ()

Lock using BSD-style locks.

valuefdTryLock :: FD -> LockMode -> IO Bool

Try to lock using BSD-style locks.

valuefdUnlock :: FD -> IO ()

Unlock using BSD-style locks.

Handles

3 declarations

valuehLock :: Handle -> LockMode -> IO ()

Lock using BSD-style locks.

valuehTryLock :: Handle -> LockMode -> IO Bool

Try to lock using BSD-style locks.

valuehUnlock :: Handle -> IO ()

Unlock using BSD-style locks.