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

Contents

Time interval handling
Conversion To/From NominalDiffTime
(Legacy) Timeout Handling

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.

Synopsis

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 #
Methods (==) :: TimeInterval -> TimeInterval -> Bool # (/=) :: TimeInterval -> TimeInterval -> Bool #
Num TimeInterval Source #	Allow `(+)` and `(-)` operations on `TimeInterval`s
Methods (+) :: TimeInterval -> TimeInterval -> TimeInterval # (-) :: TimeInterval -> TimeInterval -> TimeInterval # (*) :: TimeInterval -> TimeInterval -> TimeInterval # negate :: TimeInterval -> TimeInterval # abs :: TimeInterval -> TimeInterval # signum :: TimeInterval -> TimeInterval # fromInteger :: Integer -> TimeInterval #
Show TimeInterval Source #
Methods showsPrec :: Int -> TimeInterval -> ShowS # show :: TimeInterval -> String # showList :: [TimeInterval] -> ShowS #
Generic TimeInterval Source #
Associated Types type Rep TimeInterval :: * -> * # Methods from :: TimeInterval -> Rep TimeInterval x # to :: Rep TimeInterval x -> TimeInterval #
Binary TimeInterval Source #
Methods put :: TimeInterval -> Put # get :: Get TimeInterval # putList :: [TimeInterval] -> Put #
NFData TimeInterval Source #
Methods rnf :: TimeInterval -> () #
type Rep TimeInterval Source #
type Rep TimeInterval = D1 * (MetaData "TimeInterval" "Control.Distributed.Process.Extras.Time" "distributed-process-extras-0.3.5-7qzKH0dWmcLBNm6JMkdrjz" False) (C1 * (MetaCons "TimeInterval" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * TimeUnit)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))))

data TimeUnit Source #

Defines the time unit for a Timeout value

Constructors

Days
Hours
Minutes
Seconds
Millis
Micros

Instances

Eq TimeUnit Source #
Methods (==) :: TimeUnit -> TimeUnit -> Bool # (/=) :: TimeUnit -> TimeUnit -> Bool #
Show TimeUnit Source #
Methods showsPrec :: Int -> TimeUnit -> ShowS # show :: TimeUnit -> String # showList :: [TimeUnit] -> ShowS #
Generic TimeUnit Source #
Associated Types type Rep TimeUnit :: * -> * # Methods from :: TimeUnit -> Rep TimeUnit x # to :: Rep TimeUnit x -> TimeUnit #
Binary TimeUnit Source #
Methods put :: TimeUnit -> Put # get :: Get TimeUnit # putList :: [TimeUnit] -> Put #
NFData TimeUnit Source #
Methods rnf :: TimeUnit -> () #
type Rep TimeUnit Source #
type Rep TimeUnit = D1 * (MetaData "TimeUnit" "Control.Distributed.Process.Extras.Time" "distributed-process-extras-0.3.5-7qzKH0dWmcLBNm6JMkdrjz" False) ((:+:) * ((:+:) * (C1 * (MetaCons "Days" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "Hours" PrefixI False) (U1 )) (C1 (MetaCons "Minutes" PrefixI False) (U1 )))) ((:+:) (C1 * (MetaCons "Seconds" PrefixI False) (U1 )) ((:+:) (C1 * (MetaCons "Millis" PrefixI False) (U1 )) (C1 (MetaCons "Micros" PrefixI False) (U1 *)))))

data Delay Source #

Represents either a delay of TimeInterval, an infinite wait or no delay (i.e., non-blocking).

Constructors

Delay TimeInterval
Infinity
NoDelay

Instances

Eq Delay Source #
Methods (==) :: Delay -> Delay -> Bool # (/=) :: Delay -> Delay -> Bool #
Num Delay Source #	Allow `(+)` and `(-)` operations on `Delay`s
Methods (+) :: Delay -> Delay -> Delay # (-) :: Delay -> Delay -> Delay # (*) :: Delay -> Delay -> Delay # negate :: Delay -> Delay # abs :: Delay -> Delay # signum :: Delay -> Delay # fromInteger :: Integer -> Delay #
Show Delay Source #
Methods showsPrec :: Int -> Delay -> ShowS # show :: Delay -> String # showList :: [Delay] -> ShowS #
Generic Delay Source #
Associated Types type Rep Delay :: * -> * # Methods from :: Delay -> Rep Delay x # to :: Rep Delay x -> Delay #
Binary Delay Source #
Methods put :: Delay -> Put # get :: Get Delay # putList :: [Delay] -> Put #
NFData Delay Source #
Methods rnf :: Delay -> () #
type Rep Delay Source #
type Rep Delay = D1 * (MetaData "Delay" "Control.Distributed.Process.Extras.Time" "distributed-process-extras-0.3.5-7qzKH0dWmcLBNm6JMkdrjz" False) ((:+:) * (C1 * (MetaCons "Delay" PrefixI False) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * TimeInterval))) ((:+:) * (C1 * (MetaCons "Infinity" PrefixI False) (U1 )) (C1 (MetaCons "NoDelay" PrefixI False) (U1 *))))

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 #
Methods put :: TimeoutNotification -> Put # get :: Get TimeoutNotification # putList :: [TimeoutNotification] -> Put #

timeout :: Int -> Tag -> ProcessId -> Process () Source #

Sends the calling process TimeoutNotification tag after time microseconds

infiniteWait :: Timeout Source #

Constructs an inifinite Timeout.

noWait :: Timeout Source #

Constructs a no-wait Timeout