Copyright | (c) 2010-2011 Bas van Dijk & Roel van Dijk |
---|---|
License | BSD3 (see the file LICENSE) |
Maintainer | Bas van Dijk <v.dijk.bas@gmail.com> , Roel van Dijk <vandijk.roel@gmail.com> |
Safe Haskell | Safe |
Language | Haskell98 |
This module provides the Lock
synchronisation mechanism. It was inspired by
the Python and Java Lock
objects and should behave in a similar way. See:
http://docs.python.org/3.1/library/threading.html#lock-objects
and:
http://java.sun.com/javase/7/docs/api/java/util/concurrent/locks/Lock.html
All functions are exception safe. Throwing asynchronous exceptions will not
compromise the internal state of a Lock
.
This module is intended to be imported qualified. We suggest importing it like:
import Control.Concurrent.Lock ( Lock ) import qualified Control.Concurrent.Lock as Lock ( ... )
Documentation
Creating locks
newAcquired :: IO Lock Source #
Create a lock in the "locked" state.
Locking and unlocking
acquire :: Lock -> IO () Source #
Acquires the Lock
. Blocks if another thread has acquired the Lock
.
acquire
behaves as follows:
- When the state is "unlocked"
acquire
changes the state to "locked". - When the state is "locked"
acquire
blocks until a call torelease
in another thread wakes the calling thread. Upon awakening it will change the state to "locked".
There are two further important properties of acquire
:
acquire
is single-wakeup. That is, if there are multiple threads blocked onacquire
and the lock is released, only one thread will be woken up. The runtime guarantees that the woken thread completes itsacquire
operation.- When multiple threads are blocked on
acquire
, they are woken up in FIFO order. This is useful for providing fairness properties of abstractions built using locks. (Note that this differs from the Python implementation where the wake-up order is undefined.)
release :: Lock -> IO () Source #
release
changes the state to "unlocked" and returns immediately.
Note that it is an error to release a lock in the "unlocked" state!
If there are any threads blocked on acquire
the thread that first called
acquire
will be woken up.
Convenience functions
tryWith :: Lock -> IO a -> IO (Maybe a) Source #
A non-blocking with
. tryWith
is a convenience function which first tries to
acquire the lock. If that fails, Nothing
is returned. If it succeeds, the
computation is performed. When the computation terminates, whether normally or
by raising an exception, the lock is released and Just
the result of the
computation is returned.
wait :: Lock -> IO () Source #
- When the state is "locked",
wait
blocks until a call torelease
in another thread changes it to "unlocked". wait
is multiple-wakeup, so when multiple waiters are blocked on aLock
, all of them are woken up at the same time.- When the state is "unlocked"
wait
returns immediately.
wait
does not alter the state of the lock.