System.TimeManager

time-manager-0.1.0: Scalable timer

Safe Haskell	Safe-Inferred
Language	Haskell2010

System.TimeManager

Contents

Types
Manager
Registration
Control
Exceptions

Synopsis

type Manager = Reaper [Handle] Handle
type TimeoutAction = IO ()
data Handle
initialize :: Int -> IO Manager
stopManager :: Manager -> IO ()
killManager :: Manager -> IO ()
withManager :: Int -> (Manager -> IO a) -> IO a
withManager' :: Int -> (Manager -> IO a) -> IO a
register :: Manager -> TimeoutAction -> IO Handle
registerKillThread :: Manager -> TimeoutAction -> IO Handle
tickle :: Handle -> IO ()
cancel :: Handle -> IO ()
pause :: Handle -> IO ()
resume :: Handle -> IO ()
data TimeoutThread = TimeoutThread

Types

type Manager = Reaper [Handle] Handle Source #

A timeout manager

type TimeoutAction = IO () Source #

An action to be performed on timeout.

data Handle Source #

A handle used by Manager

Manager

initialize :: Int -> IO Manager Source #

Creating timeout manager which works every N micro seconds where N is the first argument.

stopManager :: Manager -> IO () Source #

Stopping timeout manager with onTimeout fired.

killManager :: Manager -> IO () Source #

Killing timeout manager immediately without firing onTimeout.

withManager Source #

Arguments

:: Int	timeout in microseconds
-> (Manager -> IO a)
-> IO a

Call the inner function with a timeout manager. stopManager is used after that.

withManager' Source #

Arguments

:: Int	timeout in microseconds
-> (Manager -> IO a)
-> IO a

Call the inner function with a timeout manager. killManager is used after that.

Registration

register :: Manager -> TimeoutAction -> IO Handle Source #

Registering a timeout action.

registerKillThread :: Manager -> TimeoutAction -> IO Handle Source #

Registering a timeout action of killing this thread.

Control

tickle :: Handle -> IO () Source #

Setting the state to active. Manager turns active to inactive repeatedly.

cancel :: Handle -> IO () Source #

Removing the Handle from the Manager immediately.

pause :: Handle -> IO () Source #

Setting the state to paused. Manager does not change the value.

resume :: Handle -> IO () Source #

Setting the paused state to active. This is an alias to tickle.

Exceptions

data TimeoutThread Source #

Constructors

Instances

Instances details

Exception TimeoutThread Source #
Instance details Defined in System.TimeManager Methods toException :: TimeoutThread -> SomeException # fromException :: SomeException -> Maybe TimeoutThread # displayException :: TimeoutThread -> String #
Show TimeoutThread Source #
Instance details Defined in System.TimeManager Methods showsPrec :: Int -> TimeoutThread -> ShowS # show :: TimeoutThread -> String # showList :: [TimeoutThread] -> ShowS #