System.TimeManager

Types

type Manager = Reaper [Handle] Handle

A timeout manager

type TimeoutAction = IO ()

An action to be performed on timeout.

data Handle

A handle used by Manager

Manager

initialize :: Int -> IO Manager

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

stopManager :: Manager -> IO ()

Stopping timeout manager with onTimeout fired.

killManager :: Manager -> IO ()

Killing timeout manager immediately without firing onTimeout.

withManager

Arguments

:: Int

timeout in microseconds

-> (Manager -> IO a)

-> IO a

Call the inner function with a timeout manager.

Registration

register :: Manager -> TimeoutAction -> IO Handle

Registering a timeout action.

registerKillThread :: Manager -> TimeoutAction -> IO Handle

Registering a timeout action of killing this thread.

Control

tickle :: Handle -> IO ()

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

cancel :: Handle -> IO ()

Setting the state to canceled. Manager eventually removes this without timeout action.

pause :: Handle -> IO ()

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

resume :: Handle -> IO ()

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

Exceptions

data TimeoutThread

Constructors

TimeoutThread

Instances

Show TimeoutThread

Defined in System.TimeManager

Methods

showsPrec :: Int -> TimeoutThread -> ShowS

show :: TimeoutThread -> String

showList :: [TimeoutThread] -> ShowS

Exception TimeoutThread

Defined in System.TimeManager

Methods

toException :: TimeoutThread -> SomeException

fromException :: SomeException -> Maybe TimeoutThread

displayException :: TimeoutThread -> String