Safe Haskell	None
Language	Haskell2010

Control.Eff.Concurrent.Process.Timer

Description

Functions for timeouts when receiving messages.

NOTE: If you use a single threaded scheduler, these functions will not work as expected. (This is an open TODO)

Since: 0.12.0

Synopsis

data Timeout
data TimerReference
data TimerElapsed
sendAfter :: forall r q message. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r, Typeable message, NFData message) => SchedulerProxy q -> ProcessId -> Timeout -> (TimerReference -> message) -> Eff r TimerReference
startTimer :: forall r q. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r) => SchedulerProxy q -> Timeout -> Eff r TimerReference
cancelTimer :: forall r q. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r) => SchedulerProxy q -> TimerReference -> Eff r ()
selectTimerElapsed :: TimerReference -> MessageSelector TimerElapsed
receiveAfter :: forall a r q. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r, Typeable a, NFData a, Show a) => SchedulerProxy q -> Timeout -> Eff r (Maybe a)
receiveSelectedAfter :: forall a r q. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r, Show a) => SchedulerProxy q -> MessageSelector a -> Timeout -> Eff r (Either TimerElapsed a)

Documentation

data Timeout Source #

A number of micro seconds.

Since: 0.12.0

Instances

Enum Timeout Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods succ :: Timeout -> Timeout # pred :: Timeout -> Timeout # toEnum :: Int -> Timeout # fromEnum :: Timeout -> Int # enumFrom :: Timeout -> [Timeout] # enumFromThen :: Timeout -> Timeout -> [Timeout] # enumFromTo :: Timeout -> Timeout -> [Timeout] # enumFromThenTo :: Timeout -> Timeout -> Timeout -> [Timeout] #
Eq Timeout Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods (==) :: Timeout -> Timeout -> Bool # (/=) :: Timeout -> Timeout -> Bool #
Integral Timeout Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods quot :: Timeout -> Timeout -> Timeout # rem :: Timeout -> Timeout -> Timeout # div :: Timeout -> Timeout -> Timeout # mod :: Timeout -> Timeout -> Timeout # quotRem :: Timeout -> Timeout -> (Timeout, Timeout) # divMod :: Timeout -> Timeout -> (Timeout, Timeout) # toInteger :: Timeout -> Integer #
Num Timeout Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods (+) :: Timeout -> Timeout -> Timeout # (-) :: Timeout -> Timeout -> Timeout # (*) :: Timeout -> Timeout -> Timeout # negate :: Timeout -> Timeout # abs :: Timeout -> Timeout # signum :: Timeout -> Timeout # fromInteger :: Integer -> Timeout #
Ord Timeout Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods compare :: Timeout -> Timeout -> Ordering # (<) :: Timeout -> Timeout -> Bool # (<=) :: Timeout -> Timeout -> Bool # (>) :: Timeout -> Timeout -> Bool # (>=) :: Timeout -> Timeout -> Bool # max :: Timeout -> Timeout -> Timeout # min :: Timeout -> Timeout -> Timeout #
Real Timeout Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods toRational :: Timeout -> Rational #
Show Timeout Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods showsPrec :: Int -> Timeout -> ShowS # show :: Timeout -> String # showList :: [Timeout] -> ShowS #
NFData Timeout Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods rnf :: Timeout -> () #

data TimerReference Source #

The reference to a timer started by startTimer, required to stop a timer via cancelTimer.

Since: 0.12.0

Instances

Enum TimerReference Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods succ :: TimerReference -> TimerReference # pred :: TimerReference -> TimerReference # toEnum :: Int -> TimerReference # fromEnum :: TimerReference -> Int # enumFrom :: TimerReference -> [TimerReference] # enumFromThen :: TimerReference -> TimerReference -> [TimerReference] # enumFromTo :: TimerReference -> TimerReference -> [TimerReference] # enumFromThenTo :: TimerReference -> TimerReference -> TimerReference -> [TimerReference] #
Eq TimerReference Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods (==) :: TimerReference -> TimerReference -> Bool # (/=) :: TimerReference -> TimerReference -> Bool #
Integral TimerReference Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods quot :: TimerReference -> TimerReference -> TimerReference # rem :: TimerReference -> TimerReference -> TimerReference # div :: TimerReference -> TimerReference -> TimerReference # mod :: TimerReference -> TimerReference -> TimerReference # quotRem :: TimerReference -> TimerReference -> (TimerReference, TimerReference) # divMod :: TimerReference -> TimerReference -> (TimerReference, TimerReference) # toInteger :: TimerReference -> Integer #
Num TimerReference Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods (+) :: TimerReference -> TimerReference -> TimerReference # (-) :: TimerReference -> TimerReference -> TimerReference # (*) :: TimerReference -> TimerReference -> TimerReference # negate :: TimerReference -> TimerReference # abs :: TimerReference -> TimerReference # signum :: TimerReference -> TimerReference # fromInteger :: Integer -> TimerReference #
Ord TimerReference Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods compare :: TimerReference -> TimerReference -> Ordering # (<) :: TimerReference -> TimerReference -> Bool # (<=) :: TimerReference -> TimerReference -> Bool # (>) :: TimerReference -> TimerReference -> Bool # (>=) :: TimerReference -> TimerReference -> Bool # max :: TimerReference -> TimerReference -> TimerReference # min :: TimerReference -> TimerReference -> TimerReference #
Real TimerReference Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods toRational :: TimerReference -> Rational #
Show TimerReference Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods showsPrec :: Int -> TimerReference -> ShowS # show :: TimerReference -> String # showList :: [TimerReference] -> ShowS #
NFData TimerReference Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods rnf :: TimerReference -> () #

data TimerElapsed Source #

A value to be sent when timer started with startTimer has elapsed.

Since: 0.12.0

Instances

Eq TimerElapsed Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods (==) :: TimerElapsed -> TimerElapsed -> Bool # (/=) :: TimerElapsed -> TimerElapsed -> Bool #
Ord TimerElapsed Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods compare :: TimerElapsed -> TimerElapsed -> Ordering # (<) :: TimerElapsed -> TimerElapsed -> Bool # (<=) :: TimerElapsed -> TimerElapsed -> Bool # (>) :: TimerElapsed -> TimerElapsed -> Bool # (>=) :: TimerElapsed -> TimerElapsed -> Bool # max :: TimerElapsed -> TimerElapsed -> TimerElapsed # min :: TimerElapsed -> TimerElapsed -> TimerElapsed #
Show TimerElapsed Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods showsPrec :: Int -> TimerElapsed -> ShowS # show :: TimerElapsed -> String # showList :: [TimerElapsed] -> ShowS #
NFData TimerElapsed Source #
Instance details Defined in Control.Eff.Concurrent.Process.Timer Methods rnf :: TimerElapsed -> () #

sendAfter :: forall r q message. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r, Typeable message, NFData message) => SchedulerProxy q -> ProcessId -> Timeout -> (TimerReference -> message) -> Eff r TimerReference Source #

Send a message to a given process after waiting. The message is created by applying the function parameter to the TimerReference, such that the message can directly refer to the timer.

Since: 0.12.0

startTimer :: forall r q. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r) => SchedulerProxy q -> Timeout -> Eff r TimerReference Source #

Start a new timer, after the time has elapsed, TimerElapsed is sent to calling process. The message also contains the TimerReference returned by this function. Use cancelTimer to cancel the timer. Use selectTimerElapsed to receive the message using receiveSelectedMessage. To receive messages with guarded with a timeout see receiveAfter.

Since: 0.12.0

cancelTimer :: forall r q. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r) => SchedulerProxy q -> TimerReference -> Eff r () Source #

Cancel a timer started with startTimer.

Since: 0.12.0

selectTimerElapsed :: TimerReference -> MessageSelector TimerElapsed Source #

A MessageSelector matching TimerElapsed messages created by startTimer.

Since: 0.12.0

receiveAfter :: forall a r q. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r, Typeable a, NFData a, Show a) => SchedulerProxy q -> Timeout -> Eff r (Maybe a) Source #

Wait for a message of the given type for the given time. When no message arrives in time, return Nothing. This is based on receiveSelectedAfter.

Since: 0.12.0

receiveSelectedAfter :: forall a r q. (Lifted IO q, HasCallStack, SetMember Process (Process q) r, Member Interrupts r, Show a) => SchedulerProxy q -> MessageSelector a -> Timeout -> Eff r (Either TimerElapsed a) Source #

Wait for a message of the given type for the given time. When no message arrives in time, return Left TimerElapsed. This is based on selectTimerElapsed and startTimer.

Since: 0.12.0