Garmelon/haboli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix wording and add more info to 'wait'

Browse source
This commit is contained in:
Joscha 2020-01-07 16:12:44 +00:00
parent ea9390ebd5
commit 604cb4b09b
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/Haboli/Euphoria/Client.hs
View file

@ -345,7 +345,7 @@ handle = flip Haboli.Euphoria.Client.catch
newtype Thread e a = Thread (MVar (Either (ClientException e) a)) newtype Thread e a = Thread (MVar (Either (ClientException e) a))
-- | @'fork' p@ forks a new thread running the 'Client' @p@. To wait for the -- | @'fork' p@ forks a new thread running the 'Client' @p@. To wait for the
-- thread to finish execution and collect the result, use 'wait'. -- thread to finish executing and collect the result, use 'wait'.
fork :: Client e a -> Client e (Thread e a) fork :: Client e a -> Client e (Thread e a)
fork (Client f) = do fork (Client f) = do
info <- getClientInfo info <- getClientInfo
@ -357,7 +357,9 @@ fork (Client f) = do
pure $ Thread waitVar pure $ Thread waitVar
-- | Wait for a thread to finish executing and collect the result. If the thread -- | Wait for a thread to finish executing and collect the result. If the thread
-- threw a 'ClientException', that exception is rethrown. -- threw a 'ClientException', that exception is rethrown. If the thread threw an
-- IO exception, that exception is wrapped in an 'UnexpectedException' and
-- thrown.
wait :: Thread e a -> Client e a wait :: Thread e a -> Client e a
wait (Thread waitVar) = do wait (Thread waitVar) = do
result <- liftIO $ readMVar waitVar result <- liftIO $ readMVar waitVar