Replaced talk of "blocking" with "retrying"
authorSimon Marlow <marlowsd@gmail.com>
Mon, 11 Apr 2011 10:06:37 +0000 (11:06 +0100)
committerSimon Marlow <marlowsd@gmail.com>
Mon, 11 Apr 2011 10:06:37 +0000 (11:06 +0100)
Control/Concurrent/STM/TChan.hs
Control/Concurrent/STM/TMVar.hs

index cdd62f9..18aa9f9 100644 (file)
@@ -82,7 +82,8 @@ readTChan (TChan read _write) = do
        writeTVar read tail
        return a
 
--- | Non-blocking version of 'readTChan'.
+-- | A version of 'readTChan' which does not retry. Instead it
+-- returns @Nothing@ if no value is available.
 tryReadTChan :: TChan a -> STM (Maybe a)
 tryReadTChan (TChan read _write) = do
   listhead <- readTVar read
@@ -93,8 +94,8 @@ tryReadTChan (TChan read _write) = do
       writeTVar read tl
       return (Just a)
 
--- | Get the next value from the 'TChan' without removing it,
--- blocking if the channel is empty.
+-- | Get the next value from the @TChan@ without removing it,
+-- retrying if the channel is empty.
 peekTChan :: TChan a -> STM a
 peekTChan (TChan read _write) = do
   listhead <- readTVar read
@@ -103,7 +104,8 @@ peekTChan (TChan read _write) = do
     TNil      -> retry
     TCons a _ -> return a
 
--- | Non-blocking version of 'peekTChan'.
+-- | A version of 'peekTChan' which does not retry. Instead it
+-- returns @Nothing@ if no value is available.
 tryPeekTChan :: TChan a -> STM (Maybe a)
 tryPeekTChan (TChan read _write) = do
   listhead <- readTVar read
index 05c83f6..653736f 100644 (file)
@@ -126,7 +126,8 @@ readTMVar (TMVar t) = do
     Nothing -> retry
     Just a  -> return a
 
--- | Non-blocking version of 'readTMVar'.
+-- | A version of 'readTMVar' which does not retry. Instead it
+-- returns @Nothing@ if no value is available.
 tryReadTMVar :: TMVar a -> STM (Maybe a)
 tryReadTMVar (TMVar t) = readTVar t