| Copyright | (c) Tim Watson, Jeff Epstein, Alan Zimmerman |
|---|---|
| License | BSD3 (see the file LICENSE) |
| Maintainer | Tim Watson |
| Stability | experimental |
| Portability | non-portable (requires concurrency) |
| Safe Haskell | None |
| Language | Haskell98 |
Control.Distributed.Process.Extras.Time
Description
This module provides facilities for working with time delays and timeouts.
The type Timeout and the timeout family of functions provide mechanisms
for working with threadDelay-like behaviour that operates on microsecond
values.
The TimeInterval and TimeUnit related functions provide an abstraction
for working with various time intervals, whilst the Delay type provides a
corrolary to timeout that works with these.
- microSeconds :: Int -> TimeInterval
- milliSeconds :: Int -> TimeInterval
- seconds :: Int -> TimeInterval
- minutes :: Int -> TimeInterval
- hours :: Int -> TimeInterval
- asTimeout :: TimeInterval -> Int
- after :: Int -> TimeUnit -> Int
- within :: Int -> TimeUnit -> TimeInterval
- timeToMicros :: TimeUnit -> Int -> Int
- data TimeInterval
- data TimeUnit
- data Delay
- timeIntervalToDiffTime :: TimeInterval -> NominalDiffTime
- diffTimeToTimeInterval :: NominalDiffTime -> TimeInterval
- diffTimeToDelay :: NominalDiffTime -> Delay
- delayToDiffTime :: Delay -> NominalDiffTime
- microsecondsToNominalDiffTime :: Integer -> NominalDiffTime
- type Timeout = Maybe Int
- data TimeoutNotification = TimeoutNotification Tag
- timeout :: Int -> Tag -> ProcessId -> Process ()
- infiniteWait :: Timeout
- noWait :: Timeout
Time interval handling
microSeconds :: Int -> TimeInterval Source
given a number, produces a TimeInterval of microseconds
milliSeconds :: Int -> TimeInterval Source
given a number, produces a TimeInterval of milliseconds
seconds :: Int -> TimeInterval Source
given a number, produces a TimeInterval of seconds
minutes :: Int -> TimeInterval Source
given a number, produces a TimeInterval of minutes
hours :: Int -> TimeInterval Source
given a number, produces a TimeInterval of hours
asTimeout :: TimeInterval -> Int Source
converts the supplied TimeInterval to microseconds
after :: Int -> TimeUnit -> Int Source
Convenience for making timeouts; e.g.,
receiveTimeout (after 3 Seconds) [ match (\"ok" -> return ()) ]
within :: Int -> TimeUnit -> TimeInterval Source
Convenience for making TimeInterval; e.g.,
let ti = within 5 Seconds in .....
timeToMicros :: TimeUnit -> Int -> Int Source
converts the supplied TimeUnit to microseconds
data TimeInterval Source
A time interval.
Instances
| Eq TimeInterval Source | |
| Num TimeInterval Source | Allow |
| Show TimeInterval Source | |
| Generic TimeInterval Source | |
| Binary TimeInterval Source | |
| NFData TimeInterval Source | |
| type Rep TimeInterval Source |
Defines the time unit for a Timeout value
Represents either a delay of TimeInterval, an infinite wait or no delay
(i.e., non-blocking).
Constructors
| Delay TimeInterval | |
| Infinity | |
| NoDelay |
Conversion To/From NominalDiffTime
timeIntervalToDiffTime :: TimeInterval -> NominalDiffTime Source
given a TimeInterval, provide an equivalent NominalDiffTim
diffTimeToTimeInterval :: NominalDiffTime -> TimeInterval Source
given a NominalDiffTim, provide an equivalent TimeInterval@
diffTimeToDelay :: NominalDiffTime -> Delay Source
given a NominalDiffTim, provide an equivalent Delay@
delayToDiffTime :: Delay -> NominalDiffTime Source
given a Delay, provide an equivalent NominalDiffTim
microsecondsToNominalDiffTime :: Integer -> NominalDiffTime Source
Create a NominalDiffTime from a number of microseconds.
(Legacy) Timeout Handling
type Timeout = Maybe Int Source
Represents a timeout in terms of microseconds, where Nothing stands for
infinity and Just 0, no-delay.
data TimeoutNotification Source
Send to a process when a timeout expires.
Constructors
| TimeoutNotification Tag |
Instances
| Binary TimeoutNotification Source |
timeout :: Int -> Tag -> ProcessId -> Process () Source
Sends the calling process TimeoutNotification tag after time microseconds
infiniteWait :: Timeout Source
Constructs an inifinite Timeout.