Documentation

Exception that is raised when an operation times out. Not used by the package itself, it is here so that users don't need to roll their own exception type every time.

Constructors

TimedOut

Instances

Eq TimedOut
Show TimedOut
Typeable TimedOut
Exception TimedOut

data TimeoutUnit Source

Timeout unit.

Constructors

NanoSecond
MicroSecond
MilliSecond
Second
Minute
Hour
Day
Week

Instances

Bounded TimeoutUnit
Enum TimeoutUnit
Eq TimeoutUnit
Ord TimeoutUnit
Ix TimeoutUnit
Typeable TimeoutUnit

timeoutUnitNanos :: TimeoutUnit -> Word64 Source

Amount of nanoseconds in a timeout unit.

newtype Timeout Source

Timeout in nanoseconds.

Constructors

Timeout Word64

Instances

Bounded Timeout
Enum Timeout
Eq Timeout
Integral Timeout
Num Timeout
Ord Timeout
Real Timeout
Show Timeout
Ix Timeout
Typeable Timeout

(#) :: Word64 -> TimeoutUnit -> Timeout Source

Convert the given number of timeout units to Timeout.

(#>) :: Timeout -> TimeoutUnit -> Word64 Source

Extract number of units (rounding up).

(#<) :: Timeout -> TimeoutUnit -> Word64 Source

Extract number of units (rounding down).

instantly :: Timeout Source

Zero timeout. The event in question should occur immediately.