Control.Monad.Trans.Timeout

Monad transformer for running actions with a time limit. Provides a scalable MonadTimeout instance (at least for the case of a constant number of long-running threads). If you need to use timeouts often in a computation, this is probably better than Control.Timeout.

Documentation

data TimeoutT m a

Monad transformer which gives your monad stack an ability to run actions with a timeout, and abort them if they don't finish within the time limit.

By default, e.g. if you lift or liftIO an action, it runs in the regular way without a timeout. Use one of the timeout functions, such as withTimeoutThrow, to use the timeout.

Instances

MonadTrans TimeoutT

Monad m => Monad (TimeoutT m)

Functor m => Functor (TimeoutT m)

MonadFix m => MonadFix (TimeoutT m)

Applicative m => Applicative (TimeoutT m)

MonadThrow m => MonadThrow (TimeoutT m)

MonadCatch m => MonadCatch (TimeoutT m)

MonadMask m => MonadMask (TimeoutT m)

MonadIO m => MonadIO (TimeoutT m)

(MonadIO m, MonadCatch m) => MonadTimeout (TimeoutT m) m

runTimeoutT :: (TimeUnit t, MonadIO m, MonadMask m) => TimeoutT m a -> t -> m a

withTimeoutThrow :: (MonadIO m, MonadCatch m) => m a -> TimeoutT m a

withTimeoutThrow' :: (TimeUnit t, MonadIO m, MonadCatch m) => t -> m a -> TimeoutT m a

withTimeoutCatch :: (MonadIO m, MonadCatch m) => m a -> TimeoutT m (Maybe a)

withTimeoutCatch' :: (TimeUnit t, MonadCatch m, MonadIO m) => t -> m a -> TimeoutT m (Maybe a)