Control.Distributed.Process.Extras.Time

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.

Time interval handling

microSeconds :: Int -> TimeInterval

given a number, produces a TimeInterval of microseconds

milliSeconds :: Int -> TimeInterval

given a number, produces a TimeInterval of milliseconds

seconds :: Int -> TimeInterval

given a number, produces a TimeInterval of seconds

minutes :: Int -> TimeInterval

given a number, produces a TimeInterval of minutes

hours :: Int -> TimeInterval

given a number, produces a TimeInterval of hours

asTimeout :: TimeInterval -> Int

converts the supplied TimeInterval to microseconds

after :: Int -> TimeUnit -> Int

Convenience for making timeouts; e.g.,

receiveTimeout (after 3 Seconds) [ match (\"ok" -> return ()) ]

within :: Int -> TimeUnit -> TimeInterval

Convenience for making TimeInterval; e.g.,

let ti = within 5 Seconds in .....

timeToMicros :: TimeUnit -> Int -> Int

converts the supplied TimeUnit to microseconds

data TimeInterval

A time interval.

Instances

Eq TimeInterval

Methods

(==) :: TimeInterval -> TimeInterval -> Bool

(/=) :: TimeInterval -> TimeInterval -> Bool

Num TimeInterval

Allow (+) and (-) operations on TimeIntervals

Methods

(+) :: TimeInterval -> TimeInterval -> TimeInterval

(-) :: TimeInterval -> TimeInterval -> TimeInterval

(*) :: TimeInterval -> TimeInterval -> TimeInterval

negate :: TimeInterval -> TimeInterval

abs :: TimeInterval -> TimeInterval

signum :: TimeInterval -> TimeInterval

fromInteger :: Integer -> TimeInterval

Show TimeInterval

Methods

showsPrec :: Int -> TimeInterval -> ShowS

show :: TimeInterval -> String

showList :: [TimeInterval] -> ShowS

Generic TimeInterval

Associated Types

type Rep TimeInterval :: * -> *

Methods

from :: TimeInterval -> Rep TimeInterval x

to :: Rep TimeInterval x -> TimeInterval

Binary TimeInterval

Methods

put :: TimeInterval -> Put

get :: Get TimeInterval

putList :: [TimeInterval] -> Put

NFData TimeInterval

Methods

rnf :: TimeInterval -> ()

type Rep TimeInterval

type Rep TimeInterval = D1 (MetaData "TimeInterval" "Control.Distributed.Process.Extras.Time" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" 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

Defines the time unit for a Timeout value

Constructors

Days

Hours

Minutes

Seconds

Millis

Micros

Instances

Eq TimeUnit

Methods

(==) :: TimeUnit -> TimeUnit -> Bool

(/=) :: TimeUnit -> TimeUnit -> Bool

Show TimeUnit

Methods

showsPrec :: Int -> TimeUnit -> ShowS

show :: TimeUnit -> String

showList :: [TimeUnit] -> ShowS

Generic TimeUnit

Associated Types

type Rep TimeUnit :: * -> *

Methods

from :: TimeUnit -> Rep TimeUnit x

to :: Rep TimeUnit x -> TimeUnit

Binary TimeUnit

Methods

put :: TimeUnit -> Put

get :: Get TimeUnit

putList :: [TimeUnit] -> Put

NFData TimeUnit

Methods

rnf :: TimeUnit -> ()

type Rep TimeUnit

type Rep TimeUnit = D1 (MetaData "TimeUnit" "Control.Distributed.Process.Extras.Time" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" 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

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

Constructors

Delay TimeInterval

Infinity

NoDelay

Instances

Eq Delay

Methods

(==) :: Delay -> Delay -> Bool

(/=) :: Delay -> Delay -> Bool

Num Delay

Allow (+) and (-) operations on Delays

Methods

(+) :: Delay -> Delay -> Delay

(-) :: Delay -> Delay -> Delay

(*) :: Delay -> Delay -> Delay

negate :: Delay -> Delay

abs :: Delay -> Delay

signum :: Delay -> Delay

fromInteger :: Integer -> Delay

Show Delay

Methods

showsPrec :: Int -> Delay -> ShowS

show :: Delay -> String

showList :: [Delay] -> ShowS

Generic Delay

Associated Types

type Rep Delay :: * -> *

Methods

from :: Delay -> Rep Delay x

to :: Rep Delay x -> Delay

Binary Delay

Methods

put :: Delay -> Put

get :: Get Delay

putList :: [Delay] -> Put

NFData Delay

Methods

rnf :: Delay -> ()

type Rep Delay

type Rep Delay = D1 (MetaData "Delay" "Control.Distributed.Process.Extras.Time" "distributed-process-extras-0.3.2-8M2JPG0xSQwTSM074rUzv" 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

given a TimeInterval, provide an equivalent NominalDiffTim

diffTimeToTimeInterval :: NominalDiffTime -> TimeInterval

given a NominalDiffTim, provide an equivalent TimeInterval@

diffTimeToDelay :: NominalDiffTime -> Delay

given a NominalDiffTim, provide an equivalent Delay@

delayToDiffTime :: Delay -> NominalDiffTime

given a Delay, provide an equivalent NominalDiffTim

microsecondsToNominalDiffTime :: Integer -> NominalDiffTime

Create a NominalDiffTime from a number of microseconds.

(Legacy) Timeout Handling

type Timeout = Maybe Int

Represents a timeout in terms of microseconds, where Nothing stands for infinity and Just 0, no-delay.

data TimeoutNotification

Send to a process when a timeout expires.

Constructors

TimeoutNotification Tag

Instances

Binary TimeoutNotification

Methods

put :: TimeoutNotification -> Put

get :: Get TimeoutNotification

putList :: [TimeoutNotification] -> Put

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

Sends the calling process TimeoutNotification tag after time microseconds

infiniteWait :: Timeout

Constructs an inifinite Timeout.

noWait :: Timeout

Constructs a no-wait Timeout