The TBMChan type

TBMChan is an abstract type representing a bounded closeable FIFO channel.

Build and returns a new instance of TBMChan with the given capacity. N.B., we do not verify the capacity is positive, but if it is non-positive then writeTBMChan will always retry and isFullTBMChan will always be true.

IO version of newTBMChan. This is useful for creating top-level TBMChans using unsafePerformIO, because using atomically inside unsafePerformIO isn't possible.

Read the next value from the TBMChan, retrying if the channel is empty (and not closed). We return Nothing immediately if the channel is closed and empty.

A version of readTBMChan which does not retry. Instead it returns Just Nothing if the channel is open but no value is available; it still returns Nothing if the channel is closed and empty.

Get the next value from the TBMChan without removing it, retrying if the channel is empty.

A version of peekTBMChan which does not retry. Instead it returns Just Nothing if the channel is open but no value is available; it still returns Nothing if the channel is closed and empty.

Write a value to a TBMChan, retrying if the channel is full. If the channel is closed then the value is silently discarded. Use isClosedTBMChan to determine if the channel is closed before writing, as needed.

A version of writeTBMChan which does not retry. Returns Just True if the value was successfully written, Just False if it could not be written (but the channel was open), and Nothing if it was discarded (i.e., the channel was closed).

Put a data item back onto a channel, where it will be the next item read. If the channel is closed then the value is silently discarded; you can use peekTBMChan to circumvent this in certain circumstances. N.B., this could allow the channel to temporarily become longer than the specified limit, which is necessary to ensure that the item is indeed the next one read.

Closes the TBMChan, preventing any further writes.

Returns True if the supplied TBMChan has been closed.

Returns True if the supplied TBMChan is empty (i.e., has no elements). N.B., a TBMChan can be both "empty" and "full" at the same time, if the initial limit was non-positive.

Returns True if the supplied TBMChan is full (i.e., is over its limit). N.B., a TBMChan can be both "empty" and "full" at the same time, if the initial limit was non-positive. N.B., a TBMChan may still be full after reading, if unGetTBMChan was used to go over the initial limit.

This is equivalent to: liftM (<= 0) estimateFreeSlotsTBMChan

Estimate the number of free slots. If the result is positive, then it's a minimum bound; if it's non-positive then it's exact. It will only be negative if the initial limit was negative or if unGetTBMChan was used to go over the initial limit.

This function always contends with writers, but only contends with readers when it has to; compare against freeSlotsTBMChan.

Return the exact number of free slots. The result can be negative if the initial limit was negative or if unGetTBMChan was used to go over the initial limit.

This function always contends with both readers and writers; compare against estimateFreeSlotsTBMChan.